NAV Navbar
json

Introduction

Welcome to Fonteva Service APIs. This documentation will outline how to use Fonteva APIs on the Salesforce platform. We leverage the core Salesforce REST API infrastructure to deliver our APIs. All authentication is done using core Salesforce Auth These APIs cover standard CRUD services to action services, such as paying for an order, processing a scheduled payment etc.
Almost all service APIs return camel cased field values from the desired object. For example, if there is a field named OrderApi__Is_Posted__c it will come through as isPosted. The response that is returned by the API is identical to the response that is provided via the APEX API.

Versioning

All REST APIs are versioned based on the installed release. By default, the latest version is used if no version is provided. If a previous version is required, then that can be sent as a parameter to the call.

The parameter is named version and the following are the supported options:

  1. 19R1
Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/OrderService?version=19R1
Authorization: Bearer SESSIONID

Search Request

The Search Request object is used to help filter out the results based on search criteria and fields. The following parameters can be used in junction with each other or on their own.

Parameter Required Type Description
filter false string URL-encoded SOQL filter.
limit false integer Number of records to return as maximum.
fields false string Comma separated list of field API names to return for each record.
id false string Comma separated list of Salesforce IDs to query by.
sort false string Comma separated list of field api names to sort by.
sorDir false string Direction of sort. Defaults to ASC.

Filter By ID

The ability to filter records by Salesforce IDs directly. This is similar to executing a SOQL call with a where clause.

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/AssignmentService?id=a0of200000Ia5YMAAZ,a0of200000IbDZUAA3"
Authorization: Bearer SESSIONID

Filter By Where Clause

The ability to filter records by more than Salesforce IDs. The Where clause needs to be URL-encoded to work. For example, take the following SOQL clause orderapi__is_active__c = true AND orderapi__badge_type__c = 'a0mf2000007uHNAAA2' and it will become orderapi__is_active__c%3Dtrue+AND+orderapi__badge_type__c%3D%27a0mf2000007uHNAAA2%27

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/AssignmentService?filter=orderapi__is_active__c%3Dtrue+AND+orderapi__badge_type__c%3D%27a0mf2000007uHNAAA2%27
Authorization: Bearer SESSIONID

Limit Fields

The ability to reduce the number of fields that are returned to directly match what is needed.

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/AssignmentService?fields=id,orderapi__contact__c
Authorization: Bearer SESSIONID

Assignment

Get Assignments

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/AssignmentService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "unassignedDate": null,
            "term": null,
            "subscriptionLine": null,
            "subscription": null,
            "salesOrderLine": null,
            "item": "a181U0000002EGaQAM",
            "isPrimary": true,
            "isActive": true,
            "id": "a0l1U000002IPZAQA4",
            "fullName": "Etta Brown",
            "contact": "0031U0000093uKqQAI",
            "assignmentRole": "a0k1U0000010wBXQAY",
            "assignedDate": "2019-02-17"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "unassignedDate": null,
            "term": null,
            "subscriptionLine": null,
            "subscription": null,
            "salesOrderLine": null,
            "item": "a181U0000002EGaQAM",
            "isPrimary": true,
            "isActive": true,
            "id": "a0l1U000002IPZBQA4",
            "fullName": "Etta Brown",
            "contact": "0031U0000093uKqQAI",
            "assignmentRole": "a0k1U0000010wBXQAY",
            "assignedDate": "2019-02-17"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "unassignedDate": null,
            "term": null,
            "subscriptionLine": null,
            "subscription": null,
            "salesOrderLine": null,
            "item": "a181U0000002EGeQAM",
            "isPrimary": false,
            "isActive": true,
            "id": "a0l1U000002IPMYQA4",
            "fullName": "David Brown",
            "contact": "0031U0000093uKrQAI",
            "assignmentRole": "a0k1U0000010wBVQAY",
            "assignedDate": "2019-02-17"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "unassignedDate": null,
            "term": null,
            "subscriptionLine": null,
            "subscription": null,
            "salesOrderLine": null,
            "item": null,
            "isPrimary": false,
            "isActive": true,
            "id": "a0l1U000002IPMZQA4",
            "fullName": "David Brown",
            "contact": "0031U0000093uKrQAI",
            "assignmentRole": "a0k1U0000010wBcQAI",
            "assignedDate": "2019-02-17"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "unassignedDate": null,
            "term": null,
            "subscriptionLine": null,
            "subscription": null,
            "salesOrderLine": null,
            "item": "a181U0000002EGWQA2",
            "isPrimary": false,
            "isActive": true,
            "id": "a0l1U000002IPMaQAO",
            "fullName": "David Brown",
            "contact": "0031U0000093uKrQAI",
            "assignmentRole": "a0k1U0000010wBeQAI",
            "assignedDate": "2019-02-17"
        }
    ]
}

This endpoint retrieves Assignment (OrderApi_Assignment_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.
contact ID Link to the assigned Contact record.
term ID Link to the related Term for the subscribing customer.
item ID Link to the related Item.
subscription ID Link to the related Subscription for the subscribing customer.
subscriptionLine ID Link to the related Subscription Line.
salesOrderLine ID Assignments must be linked to a source Sales Order Line.
assignmentRole ID Link to the Role for the assigned Contact on record.
fullName string Contact's full name.
isActive boolean When checked, the Contact is considered "Active." Default is checked.
isPrimary boolean When checked, the Assignment is considered "Primary."
assignedDate date Defaults to the parent Sales Order Line.
unassignedDate date The date the Contact was unassigned.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/AssignmentService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Assignment Role

Get Assignment Roles

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/AssignmentRoleService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "name": "Admin",
            "isPrimary": true,
            "isDefault": true,
            "id": "a0k1U0000010wTcQAI"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "name": "Admin",
            "isPrimary": true,
            "isDefault": false,
            "id": "a0k1U0000010wCmQAI"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "name": "Admin",
            "isPrimary": true,
            "isDefault": true,
            "id": "a0k1U0000010wBXQAY"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "name": "CTO",
            "isPrimary": true,
            "isDefault": true,
            "id": "a0k1U0000010wULQAY"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "name": "Default Attendee",
            "isPrimary": false,
            "isDefault": true,
            "id": "a0k1U000001peVkQAI"
        }
     ]
}

This endpoint retrieves Assignment Roles (OrderApi_Assignment_Role_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.
name string Configure custom roles for Contacts to be assigned to against "Assignable" Items.
isDefault boolean When checked, the Roles is considered as "Default Assignment Role."
isPrimary boolean When checked, any Contact "Assignment" linked to the Assignment Role will be considered a "Primary Contact" for the "Assigned To Record." Default is unchecked.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/AssignmentRoleService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Badge

Get Badges

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/BadgeService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "isActive": true,
            "id": "a0o1U0000003HxdQAE",
            "contact": "0031U0000093uM5QAI",
            "badgeType": null,
            "account": "0011U00000BmsrLQAR"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "isActive": true,
            "id": "a0o1U0000003HxiQAE",
            "contact": "0031U0000093uM5QAI",
            "badgeType": null,
            "account": "0011U00000BmsrLQAR"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "isActive": true,
            "id": "a0o1U000001QSNRQA4",
            "contact": "0031U0000093uKyQAI",
            "badgeType": "a0m1U000003W1exQAC",
            "account": null
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "isActive": true,
            "id": "a0o1U000001QTdaQAG",
            "contact": "0031U00000MEPMnQAP",
            "badgeType": "a0m1U000004ggKyQAI",
            "account": null
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "isActive": true,
            "id": "a0o1U000001QTduQAG",
            "contact": "0031U0000093uKyQAI",
            "badgeType": "a0m1U000004ggKyQAI",
            "account": null
        }
    ]
}

This endpoint retrieves Badges (OrderApi_Badge_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record
contact ID Link to the assigned Contact.
account ID Link to the assigned Account.
badgeType ID Salesforce ID for related Badge Type record.
isActive boolean When checked, the Badge is considered "Awarded" and "Active." It will be considered when calculating any permission or pricing configurations related to the linked Badge Type. Default is checked.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/BadgeService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Badge Type

Get Badge Types

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/BadgeTypeService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "publicDescription": null,
            "name": "Autobadge",
            "isPublished": true,
            "isActive": true,
            "imageLocation": null,
            "id": "a0m1U000003W1exQAC",
            "iconLocation": null
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "publicDescription": "Auto badge for a contact",
            "name": "Auto_Badge",
            "isPublished": true,
            "isActive": true,
            "imageLocation": "https://automation-images.s3.amazonaws.com/Thumbnail.jpg",
            "id": "a0m1U000003W0ONQA0",
            "iconLocation": null
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "publicDescription": null,
            "name": "Auto_MenuItem_Badge",
            "isPublished": true,
            "isActive": true,
            "imageLocation": null,
            "id": "a0m1U000004ggKyQAI",
            "iconLocation": null
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "publicDescription": null,
            "name": "Gold Fonteva",
            "isPublished": true,
            "isActive": true,
            "imageLocation": null,
            "id": "a0m1U000005RJN7QAO",
            "iconLocation": null
        }
    ]
}

This endpoint retrieves Badge Types (OrderApi_Badge_Type_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.
name string Name for Badge Type.
imageLocation url Distinguish the Badge Type from other Badge Types by providing the URL to a securely hosted image to use as the Badge Type Image.
iconLocation url Override the default Badge Type icon with a custom image to distinguish the Badge Type from other Badge Types.
isActive boolean When checked, the Badge Type is active and available for assignment to a Contact.
isPublished boolean When checked, Contact's assigned Badge related to the Badge Type will have the option to display the Badge on the Community Profile. (It is valid only if Fonteva Communities is enabled for your environment - contact your administrator if you have any questions.)
publicDescription string The contents of this field will publish to the Community Portal.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/BadgeTypeService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Badge Workflow

Get Badge Workflows

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/BadgeWorkflowService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "type": "Line Contact",
            "name": "BadgeTicket - Sample Badge",
            "lineContact": true,
            "lineAccount": false,
            "item": "a181U0000003KgdQAE",
            "id": "a0n1U000003wdEmQAI",
            "badgeType": null,
            "autoExpire": false,
            "assignedContacts": false
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "type": "Line Contact",
            "name": "Session1 - HAri Badge",
            "lineContact": true,
            "lineAccount": false,
            "item": "a181U0000002EHFQA2",
            "id": "a0n1U000001xNgsQAE",
            "badgeType": null,
            "autoExpire": false,
            "assignedContacts": false
        }
    ]
}

This endpoint retrieves Badge Workflows (OrderApi_Badge_Workflow_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.
name string Name for Badge Type.
assignedContacts boolean Checked when the Type field is set to "Assigned Contacts."
autoExpire boolean When checked, the Badge will automatically unassign itself from the Contact record when the Assignment record becomes inactive. "Is Active" is unchecked. Default is unchecked.
badgeType ID Link to the related Badge Type.
item Id Link to the related Item.
lineAccount boolean Checked when the Type field is set to "Line Account."
lineContact boolean Checked when the Type field is set to "Line Contact."
type string Select "Line Contact" to assign the Badge to the purchasing Customer as defined in the "Contact" lookup field on the Sales Order Line. Select "Assigned Contacts" to give the Badge to all "Active" assigned Contacts.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/BadgeWorkflowService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Business Group

Get Business Groups

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/BusinessGroupService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "type": "Business Entity",
            "transfersReceivableAccount": null,
            "transfersPayableAccount": null,
            "theme": null,
            "systemModstamp": "2019-02-04T18:01:27.000Z",
            "shippingRateBasis": "Item Weight",
            "requiredTaxFieldsCSV": null,
            "receiptPageOverride": null,
            "receiptLinesFieldset": "OrderApi__Receipt_Line_Fieldset",
            "receiptHeaderHTML": null,
            "receiptHeaderFieldsetCSV": "OrderApi__Receipt_Header_Fieldset",
            "receiptFooterHTML": null,
            "proformaInvoiceHeader": null,
            "proformaInvoiceFooter": null,
            "proformaInvoiceEmailSubject": null,
            "proformaInvoiceEmailFromName": null,
            "proformaInvoiceEmailFromAddress": null,
            "proformaInvoiceEmailBody": null,
            "proformaInvoiceAuthenticationRequired": false,
            "phone": null,
            "parentBusinessGroup": null,
            "ownerId": "0051U000003jGYDQA2",
            "name": "Automation Org for Akash",
            "merchantName": "Automation Org for Akash",
            "merchantLocation": null,
            "mailingAddress": "US",
            "lastViewedDate": "2019-04-23T16:32:29.000Z",
            "lastReferencedDate": "2019-04-23T16:32:29.000Z",
            "lastModifiedDate": "2019-02-04T18:01:27.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "isMaster": true,
            "isDeleted": false,
            "invoiceWriteOffLimit": null,
            "invoiceWriteOffAccount": null,
            "invoicePageOverride": null,
            "invoiceOverPaymentCreditMemoLimit": null,
            "invoiceLinesFieldset": "OrderApi__Invoice_Line_Fieldset",
            "invoiceHeaderHTML": null,
            "invoiceHeaderFieldsetCSV": "OrderApi__Invoice_Header_Fieldset",
            "invoiceHeader": null,
            "invoiceFooterHTML": null,
            "invoiceFooter": null,
            "id": "a0q1U0000003EvqQAE",
            "homepageURL": null,
            "enableShippingByOrderTotal": true,
            "email": null,
            "displayName": null,
            "description": "Automation Org for Akash",
            "depositAccount": "a131U0000003jcKQAQ",
            "defaultPaymentGateway": null,
            "customerSupportURL": null,
            "currencyISOCode": null,
            "creditMemoAccount": null,
            "createdDate": "2019-02-04T18:01:27.000Z",
            "createdById": "0051U000003jGYDQA2",
            "calculateSalesTax": false,
            "businessEntityType": null,
            "aRAccount": "a131U0000003jcIQAQ"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "type": "Business Entity",
            "transfersReceivableAccount": "a131U0000003jcNQAQ",
            "transfersPayableAccount": "a131U0000003jcMQAQ",
            "theme": "a0f1U000000oSabQAE",
            "systemModstamp": "2019-07-22T17:32:51.000Z",
            "shippingRateBasis": "Item Weight",
            "requiredTaxFieldsCSV": "OrderApi_Billing_State__c",
            "receiptPageOverride": null,
            "receiptLinesFieldset": "OrderApi__Receipt_Line_Fieldset",
            "receiptHeaderHTML": null,
            "receiptHeaderFieldsetCSV": "OrderApi__Receipt_Header_Fieldset",
            "receiptFooterHTML": null,
            "proformaInvoiceHeader": null,
            "proformaInvoiceFooter": null,
            "proformaInvoiceEmailSubject": null,
            "proformaInvoiceEmailFromName": null,
            "proformaInvoiceEmailFromAddress": null,
            "proformaInvoiceEmailBody": null,
            "proformaInvoiceAuthenticationRequired": false,
            "phone": "730-691-0810",
            "parentBusinessGroup": null,
            "ownerId": "0051U000003jGY2QAM",
            "name": "Foundation",
            "merchantName": "Foundation Org",
            "merchantLocation": null,
            "mailingAddress": "437 Mitchel Ramp Apt. 773\nPort Tatum, MO 29895",
            "lastViewedDate": "2019-07-22T18:22:15.000Z",
            "lastReferencedDate": "2019-07-22T18:22:15.000Z",
            "lastModifiedDate": "2019-07-22T17:32:51.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "isMaster": true,
            "isDeleted": false,
            "invoiceWriteOffLimit": 0,
            "invoiceWriteOffAccount": "a131U0000003jcLQAQ",
            "invoicePageOverride": null,
            "invoiceOverPaymentCreditMemoLimit": 10,
            "invoiceLinesFieldset": "OrderApi__Invoice_Line_Fieldset",
            "invoiceHeaderHTML": null,
            "invoiceHeaderFieldsetCSV": "OrderApi__Invoice_Header_Fieldset",
            "invoiceHeader": null,
            "invoiceFooterHTML": null,
            "invoiceFooter": null,
            "id": "a0q1U0000003EvpQAE",
            "homepageURL": null,
            "enableShippingByOrderTotal": true,
            "email": "delete_allie.carroll@yahoo.com",
            "displayName": "delete_Beahan Inc",
            "description": "Foundation",
            "depositAccount": "a131U0000003jcKQAQ",
            "defaultPaymentGateway": "a1C1U000000qG2OUAU",
            "customerSupportURL": null,
            "currencyISOCode": null,
            "creditMemoAccount": "a131U0000003jcJQAQ",
            "createdDate": "2019-02-04T18:01:27.000Z",
            "createdById": "0051U000003jGY2QAM",
            "calculateSalesTax": false,
            "businessEntityType": "Non-Profit 501(c)(3)",
            "aRAccount": "a131U0000003jcIQAQ"
        }
    ]
}

This endpoint retrieves Business Groups (OrderApi_Business_Group_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.
name string Name for Business Group.
aRAccount ID Business groups require a relationship to a default A/R account.
businessEntityType string Specify the Legal Entity Type for the Business Group.
calculateSalesTax boolean When checked, enables the tax related validations and calculations.
creditMemoAccount ID Link to the GL Account used to create new Credit Memo receipts linked to this Business Group.
customerSupportURL URL A fully qualified URL is required. A fully qualified URL contains the http:// (or https://www). If the URL is just your domain, the trailing / should also be provided.
defaultPaymentGateway ID Defines the Default Payment Gateway to the related Business Group.
depositAccount ID The default deposit account to use for posting cash entry transactions.
description string Briefly describe the ledger as you would like to see it on a report. (72 chars. or less.)
displayName string The name that should be displayed when the Business Group is referenced on Invoices and other external pages and documents. Defaults to the "Name" defined for the Business Group.
email string The email address to display to customers on Invoices and related documents.
enableShippingByOrderTotal boolean When selected, customers will see a single shipping rate for the entire order. Otherwise, customers will see shipping rates for each unique item in their order. In either case, shipping is calculated only for items that have "Require Shipping" enabled.
homepageURL URL Fully qualified URL is required. A fully qualified URL contains the http:// (or https://www). If the URL is just your domain, the trailing / should also be provided.
invoiceFooter string Custom message that displays at the bottom of all Invoices and Receipts.
invoiceFooterHTML string Custom message that displays at the bottom of all Invoices.
invoiceHeader string Custom message that displays at the top of all Invoices and Receipts.
invoiceHeaderFieldsetCSV string Stores the custom fieldsets of an Invoice header as a CSV.
invoiceHeaderHTML string Custom message that displays at the top of all Invoices and Receipts.
invoiceLinesFieldset string Stores the custom fieldsets of an Invoice Line as a CSV.
invoiceOverPaymentCreditMemoLimit decimal When an Invoice is overpaid by an amount less than or equal to the value of this field, a new Credit Memo will be created and applied against the customer's account automatically.
invoicePageOverride URL Defines the custom page that will be shown when clicking an Invoice link
invoiceWriteOffAccount ID Link to the GL Account used to write off remaining balances for Invoices linked to this Business Group.
invoiceWriteOffLimit decimal When an Invoice is underpaid by an amount lesser or equal to the value of this field, the Invoice will automatically adjust itself and write off the remaining balance due.
isMaster boolean When checked, the Business Group is enabled for e-invoicing and can connect to a Payment Gateway for e-payment processing. When unchecked, a Parent Business Group must be designated. Default is checked.
mailingAddress string The address to display on Invoices and related documents that reference the Business Group. Defaults from the Organization settings "Address" fields.
merchantLocation string Some gateways allow you to customize the location of the merchant that appears on customer's credit card statements. (Optional) provide a merchant location descriptor.
merchantName string Some gateways allow you to customize the name that appears on customer's credit card statements. (Optional) provide a custom merchant name descriptor.
parentBusinessGroup ID Lookup Relationship to Business Group. Create a hierarchy of Business Groups by department, legal entity, etc. to improve Financial Reporting.
phone string The phone number to display to customers on Invoices and related documents. Defaults to the Organization's phone number.
proformaInvoiceAuthenticationRequired boolean When checked, the customer paying a Proforma Invoice will be forced to authenticate prior to accepting payment.
proformaInvoiceEmailBody string The default message used as part of the "Send Proforma Email" workflow.
proformaInvoiceEmailFromAddress string The value in this field will auto-populate the sender's email address for Proforma Emails manually sent to your customers. User's email is used if left blank. This field is not available for automated emails (i.e. auto renewal emails).
proformaInvoiceEmailFromName string The value in this field will auto-populate the sender's name for Proforma Emails manually sent to your customers. User's Name is used if left blank. This field is not available for automated emails (i.e. auto renewal emails).
proformaInvoiceEmailSubject string The default subject of the Proforma Invoice Email sent to your customers. Your user's email will be used if this field is left blank.
proformaInvoiceFooter string The contents of this field will display inside the Footer of all Proforma Invoice documents generated from Sales Orders linked to this Business Group.
proformaInvoiceHeader string The contents of this field will display inside the header of all Proforma Invoice documents generated from Sales Orders linked to this Business Group.
receiptFooterHTML string Custom message that displays at the bottom of all Receipts.
receiptHeaderFieldsetCSV string Stores the custom fieldsets of a Receipt header as a CSV.
receiptHeaderHTML string Custom message that displays at the top of all Receipts.
receiptLinesFieldset string Stores the custom fieldsets of a Receipt Line as a CSV.
receiptPageOverride URL Defines the custom page that will be shown when clicking on a Receipt Link.
requiredTaxFieldsCSV string Enter the API name of the Sales Order Billing address field the system will require on checkout (ex. Billing_State__c).
shippingRateBasis string Select whether you want shipping to be calculated based on item weight or item value (price).
theme ID Link to the Theme to apply it to the Business Group's eInvoicing portal.
transfersPayableAccount ID The GL Account to use for intracompany transfer payable transactions.
transfersReceivableAccount ID The GL Account to use for intracompany transfer receivable transactions.
type string List of Business Group Types (Department, Affiliate, Partner, Etc.). Select the most appropriate type from the list.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/BusinessGroupService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Catalog

Get Catalogs

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/CatalogService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "placeholderImage": null,
            "parent": null,
            "name": "AutoCatalog",
            "id": "a0u1U000002rcWTQAY",
            "displayOrder": null,
            "displayFeaturedItems": false,
            "catalogFilters": "OrderApi__Price__c"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "placeholderImage": null,
            "parent": "a0u1U000002rcWTQAY",
            "name": "ChildCatalog",
            "id": "a0u1U000002rcWUQAY",
            "displayOrder": null,
            "displayFeaturedItems": false,
            "catalogFilters": "OrderApi__Price__c"
        }
    ]
}

This endpoint retrieves Catalogs (OrderApi_Catalog_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.
name string Name for Catalog.
catalogFilters string Lists the filters to be displayed on the left side of the page when on the current catalog. Displays as defined in the field.
displayFeaturedItems boolean Checking this box displays all featured items within this catalog and any child catalogs at the top of the page.
displayOrder number Displays order of catalogs that will be displayed on campaign pages
parent ID Link to the parent Item Catalog record. Use Item Catalog hierarchies to better organize your products and streamline your customers' online shopping cart experience.
placeholderImage URL Image to display if item does not have its own image.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/CatalogService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Contact

Get Contacts

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/ContactService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "attributes": {
                "type": "Contact",
                "url": "/services/data/v46.0/sobjects/Contact/0031U00000LkpoDQAR"
            },
            "Id": "0031U00000LkpoDQAR",
            "IsDeleted": false,
            "AccountId": "0011U00000BmsrSQAR",
            "LastName": "123",
            "FirstName": "123a",
            "Name": "123a 123",
            "OtherAddress": null,
            "MailingAddress": null,
            "OwnerId": "0051U000003jGY2QAM",
            "HasOptedOutOfEmail": false,
            "HasOptedOutOfFax": false,
            "DoNotCall": false,
            "CreatedDate": "2019-04-16T16:16:52.000+0000",
            "CreatedById": "0051U000003uLV7QAM",
            "LastModifiedDate": "2019-04-16T16:16:52.000+0000",
            "LastModifiedById": "0051U000003uLV7QAM",
            "SystemModstamp": "2019-04-16T16:16:52.000+0000",
            "IsEmailBounced": false,
            "PhotoUrl": "/services/images/photo/0031U00000LkpoDQAR",
            "PagesApi__Cookie_Usage_Accepted__c": false,
            "OrderApi__Assistant_Do_Not_Call__c": false,
            "OrderApi__Assistant_Email_Opt_Out__c": false,
            "OrderApi__Home_Do_Not_Call__c": false,
            "OrderApi__Is_Primary_Contact__c": false,
            "OrderApi__Mobile_Do_Not_Call__c": false,
            "OrderApi__Other_Do_Not_Call__c": false,
            "OrderApi__Other_Email_Opt_Out__c": false,
            "OrderApi__Personal_Email_Opt_Out__c": false,
            "OrderApi__Privacy_Settings__c": "private",
            "OrderApi__Sync_Address_Billing__c": false,
            "OrderApi__Sync_Address_Shipping__c": false,
            "OrderApi__Sync_Email__c": false,
            "OrderApi__Sync_Phone__c": false,
            "OrderApi__Work_Do_Not_Call__c": false,
            "OrderApi__Work_Email_Opt_Out__c": false,
            "DonorApi__Active_Recurring_Gift__c": false,
            "DonorApi__Auto_Calculate_Contact_Greetings__c": false,
            "DonorApi__Auto_Calculate_Current_Ask_Amount__c": false,
            "DonorApi__Deceased__c": false,
            "DonorApi__Default_Greeting_Type__c": "Personal Greeting",
            "DonorApi__Direct_Mail_Opt_Out__c": false,
            "DonorApi__Do_Not_Solicit__c": false,
            "DonorApi__Gift_Opportunities__c": 0,
            "DonorApi__Gifts_Outstanding__c": 0,
            "DonorApi__Gifts_Received__c": 0,
            "DonorApi__Gifts_Value__c": 0,
            "DonorApi__Include_in_Household_Greetings__c": false,
            "DonorApi__Last_Gift_Amount__c": 0,
            "DonorApi__Primary__c": false,
            "OrderApi__Edit_Community_Company_Info__c": false
        },
        {
            "attributes": {
                "type": "Contact",
                "url": "/services/data/v46.0/sobjects/Contact/0031U00000PAuJYQA1"
            },
            "Id": "0031U00000PAuJYQA1",
            "IsDeleted": false,
            "AccountId": "0011U00000BmsrSQAR",
            "LastName": "kjhgf",
            "FirstName": "7uytr",
            "Name": "7uytr kjhgf",
            "OtherAddress": null,
            "MailingAddress": null,
            "OwnerId": "0051U000003jGY2QAM",
            "HasOptedOutOfEmail": false,
            "HasOptedOutOfFax": false,
            "DoNotCall": false,
            "CreatedDate": "2019-05-28T19:06:12.000+0000",
            "CreatedById": "0051U000003uLV7QAM",
            "LastModifiedDate": "2019-05-28T19:06:12.000+0000",
            "LastModifiedById": "0051U000003uLV7QAM",
            "SystemModstamp": "2019-05-28T19:06:12.000+0000",
            "IsEmailBounced": false,
            "PhotoUrl": "/services/images/photo/0031U00000PAuJYQA1",
            "PagesApi__Cookie_Usage_Accepted__c": false,
            "OrderApi__Assistant_Do_Not_Call__c": false,
            "OrderApi__Assistant_Email_Opt_Out__c": false,
            "OrderApi__Home_Do_Not_Call__c": false,
            "OrderApi__Is_Primary_Contact__c": false,
            "OrderApi__Mobile_Do_Not_Call__c": false,
            "OrderApi__Other_Do_Not_Call__c": false,
            "OrderApi__Other_Email_Opt_Out__c": false,
            "OrderApi__Personal_Email_Opt_Out__c": false,
            "OrderApi__Privacy_Settings__c": "private",
            "OrderApi__Sync_Address_Billing__c": false,
            "OrderApi__Sync_Address_Shipping__c": false,
            "OrderApi__Sync_Email__c": false,
            "OrderApi__Sync_Phone__c": false,
            "OrderApi__Work_Do_Not_Call__c": false,
            "OrderApi__Work_Email_Opt_Out__c": false,
            "DonorApi__Active_Recurring_Gift__c": false,
            "DonorApi__Auto_Calculate_Contact_Greetings__c": false,
            "DonorApi__Auto_Calculate_Current_Ask_Amount__c": false,
            "DonorApi__Deceased__c": false,
            "DonorApi__Default_Greeting_Type__c": "Personal Greeting",
            "DonorApi__Direct_Mail_Opt_Out__c": false,
            "DonorApi__Do_Not_Solicit__c": false,
            "DonorApi__Gift_Opportunities__c": 0,
            "DonorApi__Gifts_Outstanding__c": 0,
            "DonorApi__Gifts_Received__c": 0,
            "DonorApi__Gifts_Value__c": 0,
            "DonorApi__Include_in_Household_Greetings__c": false,
            "DonorApi__Last_Gift_Amount__c": 0,
            "DonorApi__Primary__c": false,
            "OrderApi__Edit_Community_Company_Info__c": false
        }
    ]
}

This endpoint retrieves Contacts.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/ContactService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Credit Memo

Get Credit Memos

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/CreditMemoService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "status": "Posted",
            "remainingAmount": 0,
            "postedDate": "2019-04-24",
            "name": "000000000",
            "isPosted": true,
            "isDrafted": false,
            "invoice": null,
            "id": "a0z1U000001UdlDQAS",
            "entity": "Contact",
            "debitAccount": "a131U0000003jcIQAQ",
            "customerLink": "<a href=\"/0031U0000093uM5\" target=\"\">Carole White</a>",
            "creditAccount": "a131U0000003jcJQAQ",
            "contact": "0031U0000093uM5QAI",
            "businessGroup": "a0q1U0000003EvpQAE",
            "appliedAmount": 5,
            "amount": 5,
            "account": "0011U00000BmsrLQAR"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "status": "Posted",
            "remainingAmount": 6,
            "postedDate": "2019-04-24",
            "name": "000000001",
            "isPosted": true,
            "isDrafted": false,
            "invoice": "a151U000001uuz6QAA",
            "id": "a0z1U000001UdlIQAS",
            "entity": "Contact",
            "debitAccount": "a131U0000003jcIQAQ",
            "customerLink": "<a href=\"/0031U0000093uM5\" target=\"\">Carole White</a>",
            "creditAccount": "a131U0000003jcJQAQ",
            "contact": "0031U0000093uM5QAI",
            "businessGroup": "a0q1U0000003EvpQAE",
            "appliedAmount": 3,
            "amount": 9,
            "account": "0011U00000BmsrLQAR"
        }
    ]
}

This endpoint retrieves Credit Memos (OrderApi_Credit_Memo_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.
name string Auto number for Credit Memo.
account ID Link to the customer's Account record. Auto-populates with the related Contact's parent Account if not defined prior to entry.
amount decimal Total overpayments received.
appliedAmount decimal The total amount of Credit Memo Lines that have been posted related to this Credit Memo.
businessGroup ID Link to the Business Group record - Business Groups will auto-populate if not defined on entry.
contact ID Link to the customer's Contact record. Auto-populates with the related Account's Primary Contact if not defined prior to entry.
creditAccount ID The account to use for crediting additional revenue received. Default value is the linked Business Group's Credit Memo account.
customerLink string A link to the record the system considers the "Customer" as determined by the "Entity" field.
debitAccount ID The GL account to use when posting to debit. Default value is the linked Business Group's writeoff account.
entity string Select "Account" if the Credit Memo should be added to the related account, select "Contact" if the Credit Memo should be added to the related "Contact."
invoice ID Invoice where the OverPayment is made.
isDrafted boolean When checked, the Credit Memo is in a draft status.
isPosted boolean When checked, the Credit Memo creates transactions.
postedDate date The date the Credit Memo was posted.
remainingAmount decimal Total - Applied
status string Primary indicator of the Credit Memo's current status. Default value is "Draft."

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/CreditMemoService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Credit Note

Get Credit Notes

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/CreditNoteService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "total": -7,
            "postedDate": "2019-04-24",
            "ownerId": "0051U000003jGY2QAM",
            "name": "000000026",
            "memo": null,
            "lastModifiedDate": "2019-04-24T14:52:36.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "isPosted": true,
            "isDeleted": false,
            "invoiceNumber": null,
            "invoice": null,
            "id": "a2A1U0000002eEhUAI",
            "entity": "Contact",
            "customer": "Carole White",
            "currencyISOCode": "USD",
            "creditNoteDate": "2019-04-24",
            "createdDate": "2019-04-24T14:40:34.000Z",
            "createdById": "0051U000003jGY2QAM",
            "contact": "0031U0000093uM5QAI",
            "billingStreet": "4540 Gilbertson Road",
            "billingState": "Virginia",
            "billingPostalCode": "22032",
            "billingCountry": "United States",
            "billingCity": "Fairfax",
            "account": "0011U00000BmsrLQAR"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "total": -3,
            "postedDate": "2019-04-24",
            "ownerId": "0051U000003jGY2QAM",
            "name": "000000027",
            "memo": null,
            "lastModifiedDate": "2019-04-24T14:54:26.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "isPosted": true,
            "isDeleted": false,
            "invoiceNumber": "000011074",
            "invoice": "a151U000001uuz6QAA",
            "id": "a2A1U0000002eF1UAI",
            "entity": "Contact",
            "customer": "Carole White",
            "currencyISOCode": "USD",
            "creditNoteDate": "2019-04-24",
            "createdDate": "2019-04-24T14:54:07.000Z",
            "createdById": "0051U000003jGY2QAM",
            "contact": "0031U0000093uM5QAI",
            "billingStreet": "4540 Gilbertson Road",
            "billingState": "Virginia",
            "billingPostalCode": "22032",
            "billingCountry": "United States",
            "billingCity": "Fairfax",
            "account": "0011U00000BmsrLQAR"
        }
    ]
}

This endpoint retrieves Credit Notes (OrderApi_Credit_Note_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.
name string Auto number for Credit Note.
account ID Link to the customer's Account record. Auto-populates with the related Account's Primary Contact if not defined prior to entry.
billingCity string The value of this field will be updated with the Account's Billing City or Contact's Mailing City, based on "Entity" if not defined on record entry.
billingCountry string The value of this field will be updated with the Account's Billing Country or Contact's Mailing Country, based on "Entity" if not defined on record entry.
billingPostalCode string The value of this field will be updated with the Account's Billing Postal Code or Contact's Mailing Postal Code, based on "Entity" if not defined on record entry.
billingState string The value of this field will be updated with the Account's Billing State or Contact's Mailing State, based on "Entity" if not defined on record entry.
billingStreet string Billing Street derives from the Contact Mailing Street or the Account Billing Street when Calculate Billing Details is checked.
contact ID Link to the customer's Contact record. Auto-populates with the related Account's Primary Contact if not defined prior to entry.
creditNoteDate date The date the Credit Note was created.
customer string Link to the customer's record, controlled by the "Entity" field.
entity string Select "Account" if the Credit Note should be applied to the related Account, select "Contact" if the Credit Note should be applied to the related "Contact."
invoice ID Link to the Invoice that generated the Credit Note.
invoiceNumber string Invoice number related to the Invoice.
isPosted boolean Checked if the Credit Note has been posted and transactions (journal entries) have been created.
memo string Optional memo that will display on the Credit Note sent to the customer as well as on customer statements.
postedDate date The date the transaction posted.
total decimal Sum of all adjustment lines.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/CreditNoteService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

EPayment

Get EPayments

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/EPaymentService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "year": 2020,
            "verificationValue": null,
            "transactionType": "Purchase",
            "transactionToken": "U066jOctyaQnqBam5b8Dti1VskY",
            "total": 10,
            "systemModstamp": "2019-02-04T18:01:27.000Z",
            "succeeded": true,
            "storageState": "cached",
            "status": "Success",
            "state": "succeeded",
            "startDate": null,
            "sourceCode": null,
            "scheduleType": "Simple Receipt",
            "scheduleFrequency": null,
            "scheduledPayment": null,
            "salesOrder": null,
            "retainOnSuccess": false,
            "refundReceipt": null,
            "referenceToken": null,
            "receiptCreated": false,
            "processVoid": false,
            "processPayment": false,
            "phone": null,
            "pending": false,
            "paymentMethodType": "credit_card",
            "paymentMethodToken": "EOswqQyMtQYY9kSmWfRUpuf9qTJ",
            "paymentMethod": null,
            "paymentGateway": null,
            "path": "/sfsites/aura",
            "ownerId": "0051U000003jGYQQA2",
            "orderID": "000000065",
            "onTestGateway": false,
            "numberOfInstallments": null,
            "name": "0000000000",
            "month": 1,
            "message": "Succeeded!",
            "merchantNameDescriptor": null,
            "merchantLocationDescriptor": null,
            "maskedNumber": null,
            "lastViewedDate": null,
            "lastReferencedDate": null,
            "lastName": "Brown",
            "lastModifiedDate": "2019-02-04T18:01:27.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "lastFourDigits": "1111",
            "last4Digits": null,
            "isVoided": false,
            "isScheduled": false,
            "isDeleted": false,
            "ipAddress": null,
            "id": "a121U0000002UjfQAE",
            "hasErrors": false,
            "gatewayTransactionID": "55",
            "gatewayToken": "82zFORhS0sBjdwLLzk6f2CqhoF7",
            "fullName": "David Brown",
            "firstSixDigits": "411111",
            "firstName": "David",
            "errors": null,
            "errorCode": null,
            "epaymentDate": "2019-02-17",
            "ePayment": null,
            "entity": "Contact",
            "email": null,
            "eligibleForCardUpdater": false,
            "description": "Sales Order #000000065",
            "depositAccount": "a131U0000003jcKQAQ",
            "cvvMessage": null,
            "cvvCode": null,
            "currencyCode": "USD",
            "createPaymentSchedule": false,
            "createdDate": "2019-02-04T18:01:27.000Z",
            "createdById": "0051U000003jGYQQA2",
            "contact": "0031U0000093uKrQAI",
            "cardType": "visa",
            "cardNumber": "XXXX-XXXX-XXXX-1111",
            "cancelled": false,
            "businessGroup": "a0q1U0000003EvpQAE",
            "billingStreet": "7744 Mystic Lake Dr",
            "billingState": "Michigan",
            "billingPostalCode": null,
            "billingCountry": "United States",
            "billingCity": "Lake",
            "batch": null,
            "bankRoutingNumber": null,
            "bankName": null,
            "bankAccountType": null,
            "bankAccountNumber": null,
            "bankAccountHolderType": null,
            "avsMessage": null,
            "avsCode": null,
            "apiResponse": null,
            "apiAmount": "1000",
            "amount": 10,
            "account": "0011U00000BmsrNQAR"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "year": 2020,
            "verificationValue": null,
            "transactionType": "Purchase",
            "transactionToken": "X031kuNUl5JQVX2TzQwrhKR1EIv",
            "total": 45,
            "systemModstamp": "2019-02-04T18:01:27.000Z",
            "succeeded": true,
            "storageState": "cached",
            "status": "Success",
            "state": "succeeded",
            "startDate": null,
            "sourceCode": null,
            "scheduleType": "Simple Receipt",
            "scheduleFrequency": null,
            "scheduledPayment": null,
            "salesOrder": null,
            "retainOnSuccess": false,
            "refundReceipt": null,
            "referenceToken": null,
            "receiptCreated": false,
            "processVoid": false,
            "processPayment": false,
            "phone": null,
            "pending": false,
            "paymentMethodType": "credit_card",
            "paymentMethodToken": "MmikHWqIQGjqVkrZFBNGzMCs8WW",
            "paymentMethod": null,
            "paymentGateway": null,
            "path": "/sfsites/aura",
            "ownerId": "0051U000003jGYQQA2",
            "orderID": "000000069",
            "onTestGateway": false,
            "numberOfInstallments": null,
            "name": "0000000001",
            "month": 1,
            "message": "Succeeded!",
            "merchantNameDescriptor": null,
            "merchantLocationDescriptor": null,
            "maskedNumber": null,
            "lastViewedDate": null,
            "lastReferencedDate": null,
            "lastName": "Brown",
            "lastModifiedDate": "2019-02-04T18:01:27.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "lastFourDigits": "1111",
            "last4Digits": null,
            "isVoided": false,
            "isScheduled": false,
            "isDeleted": false,
            "ipAddress": null,
            "id": "a121U0000002UjgQAE",
            "hasErrors": false,
            "gatewayTransactionID": "54",
            "gatewayToken": "82zFORhS0sBjdwLLzk6f2CqhoF7",
            "fullName": "David Brown",
            "firstSixDigits": "411111",
            "firstName": "David",
            "errors": null,
            "errorCode": null,
            "epaymentDate": "2019-02-17",
            "ePayment": null,
            "entity": "Contact",
            "email": null,
            "eligibleForCardUpdater": false,
            "description": "Sales Order #000000069",
            "depositAccount": "a131U0000003jcKQAQ",
            "cvvMessage": null,
            "cvvCode": null,
            "currencyCode": "USD",
            "createPaymentSchedule": false,
            "createdDate": "2019-02-04T18:01:27.000Z",
            "createdById": "0051U000003jGYQQA2",
            "contact": "0031U0000093uKrQAI",
            "cardType": "visa",
            "cardNumber": "XXXX-XXXX-XXXX-1111",
            "cancelled": false,
            "businessGroup": "a0q1U0000003EvpQAE",
            "billingStreet": "7744 Mystic Lake Dr",
            "billingState": "Michigan",
            "billingPostalCode": null,
            "billingCountry": "United States",
            "billingCity": "Lake",
            "batch": null,
            "bankRoutingNumber": null,
            "bankName": null,
            "bankAccountType": null,
            "bankAccountNumber": null,
            "bankAccountHolderType": null,
            "avsMessage": null,
            "avsCode": null,
            "apiResponse": null,
            "apiAmount": "4500",
            "amount": 45,
            "account": "0011U00000BmsrNQAR"
        }
    ]
}

This endpoint retrieves EPayments (OrderApi_EPayment_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.
name string Auto number for ePayment.
account ID Link to the related account (if applicable).
amount decimal Sum of the "Total" field of related Payment Activity Lines.
apiAmount string API Amount (String) Value of ABS(Amount) * 100.
apiResponse string Stores the API response received from the gateway.
avsCode string AVS (Address Verification Service) returned in the response of the API transaction.
avsMessage string AVS (Address Verification Service) Message.
bankAccountHolderType string Bank account holder type for the eCheck or Direct Debit payment method (when supported by your payment gateway).
bankAccountNumber string The bank account number for eCheck or Direct Debit payments (when supported by your payment gateway).
bankAccountType string The bank account type for eCheck or Direct Debit payments (when supported by your payment gateway).
bankName string The bank name for eCheck or Direct Debit payments (when supported by your payment gateway).
bankRoutingNumber string The bank account routing number for eCheck or Direct Debit payments (when supported by your payment gateway).
batch ID Link to related batch.
billingCity string Billing City for the customer's Payment Method.
billingCountry string Billing Country for the customer's Payment Method.
billingPostalCode string Billing Postal Code for the customer's Payment Method.
billingState string Billing State for the customer's Payment Method.
billingStreet string Billing Street for the customer's Payment Method.
businessGroup ID Link to the related Business Group.
cancelled boolean Cancelled (true/false) returned in the response body of the API Transaction.
cardNumber string The masked credit card number associated with the payment method.
cardType string The credit card type (if applicable).
contact ID Link to the related Contact record if applicable.
createPaymentSchedule boolean When checked, the payment activity (if charged successfully) will create a new Payment Schedule, copying all Payment Activity Lines over to the detail of the new Payment Schedule. Default is unchecked.
cvvCode string CVV (Card Verification Value) Code.
cvvMessage string CVV (Card Verification Value) Message.
depositAccount ID Link to the deposit GL account.
description string The description sent to the payment processor.
eligibleForCardUpdater boolean When checked, the payment method is available for the Card on File Updater service where Fonteva will update any expired or changed cards in your ePayment vault so that any future transactions are processed uninterrupted.
email string The email address of the customer used to transact with the API.
entity string Valid values are "Account" and "Contact", the system uses the entity field to determine the primary customer on a given transaction.
ePayment ID Link to the related ePayment authorized for payment.
epaymentDate date The date for the ePayment.
errorCode string The error code given by the payment gateway.
errors string List of errors returned in the response of the API transaction.
firstName string The first name of the customer used to transact with the API.
firstSixDigits string The first six (6) digits of the payment method (credit card or bank account number).
fullName string The full name of the customer.
gatewayToken string The gateway token used for the API call.
gatewayTransactionID string The transaction ID for the epayment as stored by the connected payment gateway.
hasErrors boolean Checked when the API transaction responds with a one or more error messages.
ipAddress string The IP (Internet Protocol) address sent and returned in the API transaction response.
isScheduled boolean Is Scheduled.
last4Digits string The last four (4) digits of the payment method (credit card or bank account number).
lastFourDigits string The last four (4) digits of the payment method (credit card or bank account number).
lastName string The last name of the customer used to transact with the API.
maskedNumber string Masked (all but last four digits) version of the credit card or bank account number.
merchantLocationDescriptor string The merchant location descriptor returned in the ePayment API transaction response.
merchantNameDescriptor string The merchant name descriptor returned in the ePayment API transaction response.
message string The message sent in the response for the ePayment API transaction.
month integer The credit card expiration month (MM).
numberOfInstallments integer The number of Invoices or Scheduled Payments to create for the payment schedule. Required to create a new payment schedule with Schedule Type of "Termed Recurring" or "Installment".
onTestGateway boolean Checked when the API transaction was invoked using a test gateway token.
orderID string The Fonteva Sales Order or Receipt number associated with the ePayment.
path string Populates with the current web page path of the user when executing a new payment activity transaction.
paymentGateway ID The related payment gateway.
paymentMethod ID A link to the related payment method (if applicable).
paymentMethodToken string The API token for the payment method used for the transaction.
paymentMethodType string The payment method type used for the API transaction.
pending boolean Pending (true/false) returned in the response body of the API Transaction.
phone string The phone number sent to the gateway (optional/additional customer data)
processPayment boolean When checked, the systems will attempt to process the related ePayment.
processVoid boolean When checked, the system will attempt to void this ePayment.
receiptCreated boolean Checked when the ePayment transaction is successfully and the system has created a new Receipt.
referenceToken string The reference token used (in lieu of a payment method) to invoke the transaction. (Reference Transactions are not supported by all gateways.)
refundReceipt ID Refund Receipt record for which the ePayment is processed.
retainOnSuccess boolean When checked, the system will store the credit card in a secure vault, allowing you to charge the customer automatically using the same payment method at a later date.
salesOrder ID Link to related Payment Schedule.
scheduledPayment ID Link to the Scheduled Payment record that generated the ePayment
scheduleFrequency string "Daily", "Weekly", "Monthly", "Quarterly", "Semi-Annually", or "Annually" required when creating new payment schedules from an ePayment transaction.
scheduleType string "Installment", "Termed Recurring", or "Evergreen Recurring" required when creating new payment schedules from an ePayment transaction.
sourceCode ID Link to related source code.
startDate date The date to start the Payment Schedule, required to create new Payment Schedules from a ePayment transaction.
state string The current state of the transaction.
status string User-friendly status display with icon indicating success/failure of the Payment Activity.
storageState string The storage state of the payment method used in the API transaction.
succeeded boolean The transaction succeeded without error.
total decimal The total amount of the ePayment transaction.
transactionToken string The token used to transact with the gateway.
transactionType string The transaction type identified in the response of the API transaction.
verificationValue string The verification value of the payment method used in the API transaction.
year integer The credit card expiration year (YYYY).

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/EPaymentService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Event

Get Events

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/EventService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "thumbnailImageUrl": null,
            "startDate": "2019-07-13",
            "registrationTimer": 15,
            "registrationStyle": "Lightning Event",
            "name": "aqua_GBPblue_SAR",
            "isPublished": false,
            "isMultiCurrency": false,
            "isFeatured": false,
            "isActive": false,
            "imageUrl": null,
            "id": "a1i1U0000023A3kQAE",
            "eventObj": null,
            "endDate": "2019-07-14",
            "displayName": "aqua_GBPblue_SAR",
            "description": null,
            "currencyISOCode": "USD",
            "bannerImageUrl": null
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "thumbnailImageUrl": null,
            "startDate": "2019-07-12",
            "registrationTimer": 15,
            "registrationStyle": "Lightning Event",
            "name": "aqua_LTL",
            "isPublished": false,
            "isMultiCurrency": false,
            "isFeatured": false,
            "isActive": false,
            "imageUrl": null,
            "id": "a1i1U0000023A28QAE",
            "eventObj": null,
            "endDate": "2019-07-13",
            "displayName": "aqua_LTL",
            "description": null,
            "currencyISOCode": "USD",
            "bannerImageUrl": null
        }
    ]
}

This endpoint retrieves Events (EventApi_Event_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.
name string Name of Event.
bannerImageUrl URL Image displays on the event overview and registration pages.
description string Optional event description.
displayName string Event name as you would like it to appear on registration pages, calendar reminders, and emails.
endDate date The event end date.
imageUrl URL Image displays on the event overview and registration pages.
isActive boolean When checked, the Event is available for sale and for publishing to registration pages. Default is checked.
isFeatured boolean
isPublished boolean When checked, the Event and related details will be exposed on all supported APIs. Default is unchecked.
registrationStyle string Determines which page layouts are used to display the event, as well as the settings available for ticketing and/or registration.
registrationTimer integer The time allowed for purchasing an event registration.
startDate date The event start date.
thumbnailImageUrl URL Secondary image for the event.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/EventService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Invoice

Get Invoices

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/InvoiceService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "total": 11,
            "term": null,
            "subtotal": 11,
            "subscription": null,
            "status": "Posted",
            "scheduledPayment": null,
            "salesOrder": "a1N1U000001aP99UAE",
            "receipts": null,
            "postedDate": "2019-07-14",
            "paidDate": null,
            "name": "000024009",
            "invoiceDate": "2019-07-14",
            "id": "a151U0000022sY6QAI",
            "dueDate": "2019-07-14",
            "currencyISOCode": "USD",
            "creditsApplied": 0,
            "creditsAndAdjustments": 0,
            "businessGroup": "a0q1U0000003EvpQAE",
            "balanceDue": 11,
            "arAccount": "a131U0000003jcIQAQ",
            "amountPaid": 0,
            "adjustments": 0
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "total": 25,
            "term": null,
            "subtotal": 25,
            "subscription": null,
            "status": "Paid",
            "scheduledPayment": null,
            "salesOrder": "a1N1U000001aP7NUAU",
            "receipts": null,
            "postedDate": "2019-07-14",
            "paidDate": "2019-07-14",
            "name": "000024003",
            "invoiceDate": "2019-07-14",
            "id": "a151U0000022sXcQAI",
            "dueDate": "2019-07-14",
            "currencyISOCode": "USD",
            "creditsApplied": 0,
            "creditsAndAdjustments": 0,
            "businessGroup": "a0q1U0000003EvpQAE",
            "balanceDue": 0,
            "arAccount": "a131U0000003jcIQAQ",
            "amountPaid": 25,
            "adjustments": 0
        }
    ]
}

This endpoint retrieves Invoices (OrderApi_Invoice_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/InvoiceService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Invoice Line

Get Invoice Lines

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/InvoiceLineService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "totalWithTax": null,
            "total": 24,
            "taxPercent": 0,
            "taxOverride": false,
            "taxAmount": null,
            "SystemModstamp": "2019-02-04T18:01:27.000Z",
            "subtotal": 24,
            "subscriptionPlan": "a1W1U0000002HzyUAE",
            "subscription": null,
            "shippingStreet": null,
            "shippingState": null,
            "shippingPostalCode": null,
            "shippingCountry": null,
            "shippingContact": null,
            "shippingCity": null,
            "salesOrderLine": "a1M1U0000014UWIUA2",
            "salePrice": 24,
            "quantity": 1,
            "priceRule": null,
            "priceOverride": true,
            "postedDate": null,
            "paymentPriority": null,
            "parentSalesOrderLine": null,
            "Name": "0000000132",
            "listPrice": 120,
            "lineDescription": "AutoTermedFiveInstallmentInvoicePlan",
            "LastModifiedDate": "2019-02-04T18:01:27.000Z",
            "LastModifiedById": "0051U000003jGY2QAM",
            "itemClass": "a161U0000003uZfQAI",
            "item": "a181U0000002EH1QAM",
            "isTax": false,
            "isShippingRate": false,
            "isRenewal": false,
            "isPosted": false,
            "IsDeleted": false,
            "isChildLine": false,
            "isAdjustment": false,
            "invoiceLine": null,
            "invoice": "a151U000001Ap6kQAC",
            "Id": "a141U0000003PvVQAU",
            "gLAccount": "a131U0000003jcPQAQ",
            "endDate": "2020-02-18",
            "deferredRevenueAdjustment": false,
            "creditsApplied": 0,
            "creditNote": null,
            "creditMemo": null,
            "CreatedDate": "2019-02-04T18:01:27.000Z",
            "CreatedById": "0051U000003jGY2QAM",
            "contact": null,
            "calculateShippingDetails": true,
            "businessGroup": "a0q1U0000003EvpQAE",
            "balanceDue": 24,
            "autoCalculateActivationDate": true,
            "aRAccount": "a131U0000003jcIQAQ",
            "amountRefunded": 0,
            "amountPaid": 0,
            "adjustments": 0,
            "adjustmentReason": null,
            "activationDate": "2019-02-19"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "totalWithTax": null,
            "total": 24,
            "taxPercent": 0,
            "taxOverride": false,
            "taxAmount": null,
            "SystemModstamp": "2019-02-04T18:01:27.000Z",
            "subtotal": 24,
            "subscriptionPlan": "a1W1U0000002HzyUAE",
            "subscription": null,
            "shippingStreet": null,
            "shippingState": null,
            "shippingPostalCode": null,
            "shippingCountry": null,
            "shippingContact": null,
            "shippingCity": null,
            "salesOrderLine": "a1M1U0000014UWIUA2",
            "salePrice": 24,
            "quantity": 1,
            "priceRule": null,
            "priceOverride": true,
            "postedDate": null,
            "paymentPriority": null,
            "parentSalesOrderLine": null,
            "Name": "0000000133",
            "listPrice": 120,
            "lineDescription": "AutoTermedFiveInstallmentInvoicePlan",
            "LastModifiedDate": "2019-02-04T18:01:27.000Z",
            "LastModifiedById": "0051U000003jGY2QAM",
            "itemClass": "a161U0000003uZfQAI",
            "item": "a181U0000002EH1QAM",
            "isTax": false,
            "isShippingRate": false,
            "isRenewal": false,
            "isPosted": false,
            "IsDeleted": false,
            "isChildLine": false,
            "isAdjustment": false,
            "invoiceLine": null,
            "invoice": "a151U000001Ap6lQAC",
            "Id": "a141U0000003PvWQAU",
            "gLAccount": "a131U0000003jcPQAQ",
            "endDate": "2020-02-18",
            "deferredRevenueAdjustment": false,
            "creditsApplied": 0,
            "creditNote": null,
            "creditMemo": null,
            "CreatedDate": "2019-02-04T18:01:27.000Z",
            "CreatedById": "0051U000003jGY2QAM",
            "contact": null,
            "calculateShippingDetails": true,
            "businessGroup": "a0q1U0000003EvpQAE",
            "balanceDue": 24,
            "autoCalculateActivationDate": true,
            "aRAccount": "a131U0000003jcIQAQ",
            "amountRefunded": 0,
            "amountPaid": 0,
            "adjustments": 0,
            "adjustmentReason": null,
            "activationDate": "2019-02-19"
        }
    ]
}

This endpoint retrieves Invoice Lines (OrderApi_Invoice_Line_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/InvoiceLineService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Item Class

Get Item Classes

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/ItemClassService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "useDefaultTaxRate": false,
            "taxClass": null,
            "systemModstamp": "2019-07-02T16:50:54.000Z",
            "subscriptionPlanDisplayLabel": null,
            "soldInventory": null,
            "shippingGLAccount": null,
            "revenueRecognitionTermRule": null,
            "revenueRecognitionRule": null,
            "revenueRecognitionDate": null,
            "requireShipping": false,
            "requireAssignments": false,
            "refresh": false,
            "ownerId": "0051U000003jGY2QAM",
            "name": "001041f5-c778-4-Ticket Class",
            "lastViewedDate": "2019-07-03T14:14:55.000Z",
            "lastReferencedDate": "2019-07-03T14:14:55.000Z",
            "lastModifiedDate": "2019-07-02T16:50:54.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "isTicketTypeClass": true,
            "isTaxDeductible": false,
            "isTaxable": false,
            "isTax": false,
            "isSubscription": false,
            "isSponsorClass": false,
            "isShippingCarrier": false,
            "isService": false,
            "isScheduleItemClass": false,
            "isInventoried": false,
            "isglobalation": null,
            "isEventSession": false,
            "isEvent": true,
            "isDownloadable": false,
            "isDeleted": false,
            "isContribution": false,
            "isActive": false,
            "interviewFormDisplayLabel": null,
            "id": "a161U0000003uYjQAI",
            "flexDayOfTheMonth": null,
            "event": null,
            "enableItemClassInventory": false,
            "enableAssignments": true,
            "enableAssignmentInventory": false,
            "disableScheduling": false,
            "description": null,
            "deferRevenue": false,
            "deferredRevenueTerm": null,
            "deferredRevenueAccount": null,
            "createdDate": "2019-02-04T18:01:27.000Z",
            "createdById": "0051U000003jGY2QAM",
            "businessGroup": "a0q1U0000003EvpQAE",
            "availableInventory": null,
            "assignToItem": false,
            "assignmentSObject": "EventApi__Attendee__c",
            "assignmentsDisplayLabel": null,
            "assignmentInventory": null,
            "activeAssignments": null
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "useDefaultTaxRate": false,
            "taxClass": null,
            "systemModstamp": "2019-07-02T16:51:17.000Z",
            "subscriptionPlanDisplayLabel": null,
            "soldInventory": null,
            "shippingGLAccount": null,
            "revenueRecognitionTermRule": null,
            "revenueRecognitionRule": null,
            "revenueRecognitionDate": null,
            "requireShipping": false,
            "requireAssignments": false,
            "refresh": false,
            "ownerId": "0051U000003jGY2QAM",
            "name": "001cf8ad-5afd-4-Ticket Class",
            "lastViewedDate": null,
            "lastReferencedDate": null,
            "lastModifiedDate": "2019-07-02T16:51:17.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "isTicketTypeClass": true,
            "isTaxDeductible": false,
            "isTaxable": false,
            "isTax": false,
            "isSubscription": false,
            "isSponsorClass": false,
            "isShippingCarrier": false,
            "isService": false,
            "isScheduleItemClass": false,
            "isInventoried": false,
            "isglobalation": null,
            "isEventSession": false,
            "isEvent": true,
            "isDownloadable": false,
            "isDeleted": false,
            "isContribution": false,
            "isActive": false,
            "interviewFormDisplayLabel": null,
            "id": "a161U000000rjYBQAY",
            "flexDayOfTheMonth": null,
            "event": null,
            "enableItemClassInventory": false,
            "enableAssignments": true,
            "enableAssignmentInventory": false,
            "disableScheduling": false,
            "description": null,
            "deferRevenue": false,
            "deferredRevenueTerm": null,
            "deferredRevenueAccount": null,
            "createdDate": "2019-03-17T06:55:20.000Z",
            "createdById": "0051U000003jGY2QAM",
            "businessGroup": "a0q1U0000003EvqQAE",
            "availableInventory": null,
            "assignToItem": false,
            "assignmentSObject": "EventApi__Attendee__c",
            "assignmentsDisplayLabel": null,
            "assignmentInventory": null,
            "activeAssignments": null
        }
    ]
}

This endpoint retrieves Item Classes (OrderApi_Item_Class_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/ItemClassService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Item

Get Items

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/ItemService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "taxPercent": null,
            "taxLocale": null,
            "taxClass": null,
            "subscriptionPlans": null,
            "requireAssignments": false,
            "renewalForm": null,
            "priceRules": null,
            "price": 78,
            "name": "6",
            "lineDescription": "6",
            "itemPackageItems": null,
            "itemClass": "a161U000001BW5JQAW",
            "isTaxable": false,
            "isTax": false,
            "isSubscription": false,
            "isShippingCarrier": null,
            "isMultiCurrency": false,
            "isDefaultTaxRate": false,
            "isDefaultShippingRate": false,
            "isContribution": false,
            "inventoryMessage": null,
            "interviewFormDisplayLabel": null,
            "imageUrl": "https://s3.us-east-1.amazonaws.com/fonteva-customer-media/00D1U000000FLVyUAO/WcRwRzNr_placeholder_svg",
            "images": [
                "https://s3.us-east-1.amazonaws.com/fonteva-customer-media/00D1U000000FLVyUAO/WcRwRzNr_placeholder_svg"
            ],
            "id": "a181U000000XO3ZQAW",
            "hasIncludedItems": null,
            "form": null,
            "eStoreShortDescription": null,
            "eStoreDescription": null,
            "enableCancellationRequest": false,
            "enableAssignments": false,
            "displayName": "6",
            "disablePriceRules": false,
            "description": null,
            "currencyISOCode": "USD",
            "assignmentsDisplayLabel": null,
            "assignmentInstructions": null
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "taxPercent": null,
            "taxLocale": null,
            "taxClass": null,
            "subscriptionPlans": null,
            "requireAssignments": false,
            "renewalForm": null,
            "priceRules": null,
            "price": 123,
            "name": "A",
            "lineDescription": "A (Jake_Single_Event)",
            "itemPackageItems": null,
            "itemClass": "a161U000001Oz8aQAC",
            "isTaxable": false,
            "isTax": false,
            "isSubscription": false,
            "isShippingCarrier": null,
            "isMultiCurrency": false,
            "isDefaultTaxRate": false,
            "isDefaultShippingRate": false,
            "isContribution": false,
            "inventoryMessage": null,
            "interviewFormDisplayLabel": null,
            "imageUrl": null,
            "images": [],
            "id": "a181U00000118hqQAA",
            "hasIncludedItems": null,
            "form": null,
            "eStoreShortDescription": null,
            "eStoreDescription": null,
            "enableCancellationRequest": false,
            "enableAssignments": true,
            "displayName": "A (Jake_Single_Event)",
            "disablePriceRules": false,
            "description": null,
            "currencyISOCode": "USD",
            "assignmentsDisplayLabel": null,
            "assignmentInstructions": null
        }
    ]
}

This endpoint retrieves Items (OrderApi_Item_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/ItemService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Item Prices

Get Item Price

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/ItemPriceService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

[
    {
        "item": "a181U0000002EHU",
        "account": null,
        "contact": "0031U0000093uKx",
        "subPlan": null,
        "sourceCode": null,
        "quantity": 1
    }
]

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "subPlan": null,
            "sourceCode": null,
            "quantity": 1,
            "priceRule": {
                "sObj": null,
                "fieldToPackageMap": null,
                "ticketType": null,
                "taxInclusivePrice": 10,
                "systemModstamp": "2019-07-24T05:47:06.000Z",
                "startDate": null,
                "scheduleItem": null,
                "requiredSubscriptionPlans": null,
                "requiredSourceCodes": null,
                "requiredBadgeTypes": null,
                "priceRuleVariables": [],
                "price": 10,
                "ownerId": "0051U000003jGY2QAM",
                "numTimesUsed": 4,
                "name": "DEFAULT",
                "minQuantity": null,
                "minAssignments": null,
                "maxQuantity": null,
                "maxNumAvailable": null,
                "maxAssignments": null,
                "limitPerContact": null,
                "limitPerAccount": null,
                "lastModifiedDate": "2019-07-24T05:47:06.000Z",
                "lastModifiedById": "0051U000003jGY2QAM",
                "itemClass": null,
                "item": "a181U0000002EHUQA2",
                "isPromotionalPrice": false,
                "isOnSitePrice": false,
                "isMultiCurrency": false,
                "isEarlyBirdPrice": false,
                "isDeleted": false,
                "isDefault": true,
                "isActive": true,
                "id": "a1G1U00000017SNUAY",
                "endDate": null,
                "currentNumAvailable": null,
                "currencyISOCode": "USD",
                "createdDate": "2019-02-04T18:01:27.000Z",
                "createdById": "0051U000003jGY2QAM"
            },
            "item": "a181U0000002EHUQA2",
            "contact": "0031U0000093uKxQAI",
            "badgesTypes": null,
            "badges": null,
            "account": null
        }
    ]
}

This endpoint retrieves prices for Items.

Request Detail

Parameter Required Type Description
item true ID Salesforce ID for Item record.
contact false ID Salesforce ID for Contact record.
account false ID Salesforce ID for Account record.
subPlan false ID Salesforce ID for Subscription Plan.
quantity true integer Number of items being purchased.
sourceCode false ID Salesforce ID for Source Code record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/ItemPriceService

Known Address

Get Known Addresses

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/KnownAddressService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": []
}

This endpoint retrieves Known Addresses (OrderApi_Known_Address_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/KnownAddressService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Order Payment

Post Order Payment

Verb: POST
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/OrderPaymentService
Authorization: Bearer SESSIONID

JSON structure required to post

{
   "record" : "a1P2E000007Tel2",
   "paymentGateway": "a1E2E000003IwFz",
   "paymentMethodId" : "a1F2E000006QOFc",
   "paymentMethodToken" : "Y7pHuq3nQs1Qza3gfgyJIGtOe65"
}

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": {
        "sObj": null,
        "fieldToPackageMap": {},
        "receiptId": "a1I1U0000025MPWUA2",
        "epaymentId": "a121U0000012ecEQAQ",
        "checkoutUrl": null,
        "checkoutForm": null
    }
}

This endpoint pays for an Sales Order/EPayment. Requires JSON to be posted to endpoint. The record id must be specified to make sure that payment goes through. This endpoint will respond with Receipt Id if successful.

Request Detail

Parameter Required Type Description
record true ID Salesforce ID for record to pay.
paymentGateway true ID Salesforce ID for Payment Gateway to pay with.
paymentMethodId false ID Salesforce ID for Payment Method.
paymentMethodToken true string Tokenized string for payment method that will be used to charge order.

HTTP Request

POST https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/OrderPaymentService

Order Service

Get Order

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/OrderService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "total": 0,
            "status": "Open",
            "sourceCode": null,
            "receipt": null,
            "postingEntity": "Receipt",
            "paymentTerms": "a1E1U0000015rknUAA",
            "paymentGateway": "a1C1U000000qG2OUAU",
            "name": "000022310",
            "lines": null,
            "LastModifiedDate": "2019-05-10T04:00:42.000+0000",
            "isProforma": false,
            "isPosted": false,
            "isPendingPayment": false,
            "isMultiCurrencyOrg": null,
            "isClosed": false,
            "invoiceDate": null,
            "id": "a1N1U000001hY3xUAE",
            "entity": "Contact",
            "dueDate": null,
            "currencyISOCode": "USD",
            "CreatedDate": "2019-05-10T04:00:13.000+0000",
            "contact": "0031U0000093uKwQAI",
            "closedDate": null,
            "businessGroup": "a0q1U0000003EvpQAE",
            "account": "0011U00000BmsrRQAR"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "total": 10,
            "status": "Open",
            "sourceCode": null,
            "receipt": null,
            "postingEntity": "Receipt",
            "paymentTerms": "a1E1U0000015rknUAA",
            "paymentGateway": null,
            "name": "000049239",
            "lines": null,
            "LastModifiedDate": "2019-07-19T11:23:21.000+0000",
            "isProforma": false,
            "isPosted": false,
            "isPendingPayment": false,
            "isMultiCurrencyOrg": null,
            "isClosed": false,
            "invoiceDate": null,
            "id": "a1N1U000001aX5tUAE",
            "entity": "Contact",
            "dueDate": null,
            "currencyISOCode": "USD",
            "CreatedDate": "2019-07-19T11:23:08.000+0000",
            "contact": "0031U0000093uKwQAI",
            "closedDate": null,
            "businessGroup": "a0q1U0000003EvpQAE",
            "account": "0011U00000BmsrRQAR"
        }
    ]
}

This endpoint retrieves Sales Orders (OrderApi_Sales_Order_c).

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/OrderService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Create Order

Verb: POST
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/OrderService
Authorization: Bearer SESSIONID

JSON structure required to post

{
}

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": {
        "sObj": null,
        "fieldToPackageMap": null,
        "total": 0,
        "status": "Open",
        "sourceCode": null,
        "receipt": null,
        "postingEntity": "Receipt",
        "paymentTerms": "a1E1U0000015rknUAA",
        "paymentGateway": null,
        "name": "000050460",
        "lines": [],
        "LastModifiedDate": "2019-07-23T01:46:59.000+0000",
        "isProforma": false,
        "isPosted": false,
        "isPendingPayment": false,
        "isMultiCurrencyOrg": null,
        "isClosed": false,
        "invoiceDate": null,
        "id": "a1N1U000001abZyUAI",
        "entity": "Account",
        "dueDate": null,
        "currencyISOCode": "USD",
        "CreatedDate": "2019-07-23T01:46:59.000+0000",
        "contact": "0031U0000093uM4QAI",
        "closedDate": null,
        "businessGroup": "a0q1U0000003EvpQAE",
        "account": "0011U00000BmsrUQAR"
    }
}

This endpoint creates a Sales Order. It requires JSON to be posted to endpoint.

HTTP Request

POST https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/OrderService

Create Order Lines

Verb: POST
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/OrderService
Authorization: Bearer SESSIONID

JSON structure required to post

{
    "id": "a1N1U000001abZyUAI",
    "lines": [
        {
            "item": "a181U0000002EHU",
            "salesOrder" : "a1N1U000001abZyUAI",
            "priceOverride" : false,
            "systemOverride" : false,
            "isRequiredPackageItem" : false,
            "isInstallmentCalculated" : false
        }
    ]
}

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": {
        "sObj": null,
        "fieldToPackageMap": null,
        "total": 0,
        "status": "Open",
        "sourceCode": null,
        "receipt": null,
        "postingEntity": "Receipt",
        "paymentTerms": "a1E1U0000015rknUAA",
        "paymentGateway": null,
        "name": "000050460",
        "lines": [],
        "LastModifiedDate": "2019-07-23T01:46:59.000+0000",
        "isProforma": false,
        "isPosted": false,
        "isPendingPayment": false,
        "isMultiCurrencyOrg": null,
        "isClosed": false,
        "invoiceDate": null,
        "id": "a1N1U000001abZyUAI",
        "entity": "Account",
        "dueDate": null,
        "currencyISOCode": "USD",
        "CreatedDate": "2019-07-23T01:46:59.000+0000",
        "contact": "0031U0000093uM4QAI",
        "closedDate": null,
        "businessGroup": "a0q1U0000003EvpQAE",
        "account": "0011U00000BmsrUQAR"
    }
}

This endpoint creates and updates Sales Order Lines. It requires JSON to be posted to an endpoint. If no Sales Order is provided in the lines array, it will auto-associate to the Sales Order. This solution also allows user to create Order and Order Lines using one REST API call.

HTTP Request

POST https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/OrderService

Update Order/Lines

Verb: PUT
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/OrderService
Authorization: Bearer SESSIONID

JSON structure required to post

{
    "id": "a1N1U000001abZyUAI",
    "lines": [
        {
            "item": "a181U0000002EHU",
            "salesOrder" : "a1N1U000001abZyUAI",
            "priceOverride" : false,
            "systemOverride" : false,
            "isRequiredPackageItem" : false,
            "isInstallmentCalculated" : false
        }
    ]
}

The above command returns JSON structured like this:


This endpoint allows updates of Sales Order and Sales Order Lines

HTTP Request

PUT https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/OrderService

Delete Order/Lines

Verb: DELETE
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/OrderService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": {},
    "data": null
}

This endpoint deletes Sales Order/Lines using a comma separated list of IDs.

Request Detail

Parameter Required Type Description
id true string Comma separated list of Salesforce IDs to delete. Must be Sales Order or Sales Order Lines.

HTTP Request

DELETE https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/OrderService

Order Summary

Get Order Summaries

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/OrderSummaryService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "systemModstamp": "2019-05-08T12:34:19.000Z",
            "showOutstandingCredits": false,
            "pdfURL": null,
            "ownerId": "0051U000003jGY2QAM",
            "orderSummaryURL": null,
            "orders": [
                "a1N1U000001LGSxUAO",
                "a1N1U0000002fynUAA"
            ],
            "name": "00000074",
            "memo": null,
            "lastModifiedDate": "2019-05-08T12:34:19.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "isDeleted": false,
            "invoices": [],
            "id": "a2B1U0000003JAoUAM",
            "filterCriteria": "{\"orders\" :[\"a1N1U000001LGSxUAO\",\"a1N1U0000002fyn\"]}",
            "entity": "Contact",
            "dateCreated": "2019-04-29",
            "customerLink": "<a href=\"/0031U0000093uKw\" target=\"_blank\">Francis Riley</a>",
            "createdDate": "2019-04-29T07:03:13.000Z",
            "createdById": "0051U000003jGY2QAM",
            "contact": "0031U0000093uKwQAI",
            "addressTo": "3355 S Wakefield St #B,<br>Arlington<br>22206, VA<br> ",
            "account": null
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "systemModstamp": "2019-05-02T17:39:51.000Z",
            "showOutstandingCredits": false,
            "pdfURL": null,
            "ownerId": "0051U000003jGY2QAM",
            "orderSummaryURL": null,
            "orders": [
                "a1N1U000001LgDrUAK"
            ],
            "name": "00000093",
            "memo": "<b>Donec venenatis vulputate lorem. Cras sagittis.</b><br>        Fusce egestas elit eget lorem. Donec vitae orci sed dolor rutrum auctor.In ut quam vitae odio lacinia tincidunt. In turpis.<br>        Phasellus dolor. Phasellus gravida semper nisi.<br><a href=\"http://www.google.com\" target=\"_blank\">Donec mollis hendrerit risus. Mauris sollicitudin fermentum libero.ce vel dui. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.</a>",
            "lastModifiedDate": "2019-05-02T17:39:51.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "isDeleted": false,
            "invoices": [
                "a151U000001vMT8QAM"
            ],
            "id": "a2B1U0000003JKfUAM",
            "filterCriteria": "{ \r\n\"invoices\" :[\"a151U000001vMT8\"], \r\n\"orders\" :[\"a1N1U000001LgDr\"] \r\n}",
            "entity": "Contact",
            "dateCreated": "2019-05-02",
            "customerLink": "<a href=\"/0031U00000Lkpkk\" target=\"_blank\">Jennifer Armstrong</a>",
            "createdDate": "2019-05-02T16:59:01.000Z",
            "createdById": "0051U000003jGY2QAM",
            "contact": "0031U00000LkpkkQAB",
            "addressTo": "3355 S Wakefield St #B,Arlington,Virginia,22206,United States",
            "account": null
        }
    ]
}

This endpoint retrieves Order Summaries (OrderApi_Order_Summary_c).

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/OrderSummaryService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Create Order Summary

Verb: POST
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/OrderSummaryService
Authorization: Bearer SESSIONID

JSON structure required to post

{
    "showOutstandingCredits": false,
    "orders": [
        "a1N1U000001LGSxUAO",
        "a1N1U0000002fynUAA"
    ],
    "entity": "Contact",
    "contact": "0031U0000093uKwQAI",
    "addressTo": "3355 S Wakefield St #B,<br>Arlington<br>22206, VA<br> ",
    "account": null
}

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "systemModstamp": "2019-05-02T17:39:51.000Z",
            "showOutstandingCredits": false,
            "pdfURL": null,
            "ownerId": "0051U000003jGY2QAM",
            "orderSummaryURL": null,
            "orders": [
                "a1N1U000001LgDrUAK"
            ],
            "name": "00000093",
            "memo": "<b>Donec venenatis vulputate lorem. Cras sagittis.</b><br>        Fusce egestas elit eget lorem. Donec vitae orci sed dolor rutrum auctor.In ut quam vitae odio lacinia tincidunt. In turpis.<br>        Phasellus dolor. Phasellus gravida semper nisi.<br><a href=\"http://www.google.com\" target=\"_blank\">Donec mollis hendrerit risus. Mauris sollicitudin fermentum libero.ce vel dui. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.</a>",
            "lastModifiedDate": "2019-05-02T17:39:51.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "isDeleted": false,
            "invoices": [
                "a151U000001vMT8QAM"
            ],
            "id": "a2B1U0000003JKfUAM",
            "filterCriteria": "{ \r\n\"invoices\" :[\"a151U000001vMT8\"], \r\n\"orders\" :[\"a1N1U000001LgDr\"] \r\n}",
            "entity": "Contact",
            "dateCreated": "2019-05-02",
            "customerLink": "<a href=\"/0031U00000Lkpkk\" target=\"_blank\">Jennifer Armstrong</a>",
            "createdDate": "2019-05-02T16:59:01.000Z",
            "createdById": "0051U000003jGY2QAM",
            "contact": "0031U00000LkpkkQAB",
            "addressTo": "3355 S Wakefield St #B,Arlington,Virginia,22206,United States",
            "account": null
        }
    ]
}

This endpoint creates a Order Summary. It requires JSON to be posted to the endpoint.

HTTP Request

POST https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/OrderSummaryService

Package Item

Get Package Items

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/PackageItemService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "parentItem": "a181U0000002EGdQAM",
            "packageItem": null,
            "numberOfFreeItems": null,
            "name": "000000000",
            "minimumQuantity": 1,
            "maximumQuantityPerItem": null,
            "maximumQuantity": null,
            "markForDelete": null,
            "itemPrice": null,
            "itemName": null,
            "item": "a181U0000002EHRQA2",
            "isRequired": false,
            "isRecommended": false,
            "isMultiCurrency": false,
            "isGroup": false,
            "id": "a1B1U0000016N17UAE",
            "groupInstructionWrapper": {
                "id": "a1B1U0000016N17UAE",
                "groupInstructionsText": null
            },
            "groupInstructionsText": null,
            "groupHeader": null,
            "displayOrder": 0,
            "displayItem": false,
            "disableQuantity": null,
            "currencyISOCode": "USD",
            "childPackageItems": null,
            "calculatePricing": false
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "parentItem": "a181U0000002EGdQAM",
            "packageItem": null,
            "numberOfFreeItems": null,
            "name": "000000001",
            "minimumQuantity": 1,
            "maximumQuantityPerItem": null,
            "maximumQuantity": null,
            "markForDelete": null,
            "itemPrice": null,
            "itemName": null,
            "item": "a181U0000002EHUQA2",
            "isRequired": false,
            "isRecommended": false,
            "isMultiCurrency": false,
            "isGroup": false,
            "id": "a1B1U0000016N18UAE",
            "groupInstructionWrapper": {
                "id": "a1B1U0000016N18UAE",
                "groupInstructionsText": null
            },
            "groupInstructionsText": null,
            "groupHeader": null,
            "displayOrder": 0,
            "displayItem": false,
            "disableQuantity": null,
            "currencyISOCode": "USD",
            "childPackageItems": null,
            "calculatePricing": false
        }
    ]
}

This endpoint retrieves Package Items (OrderApi_Package_Item_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/PackageItemService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Payment Api Service

Call Payment Processor

Verb: POST
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/PaymentAPIService
Authorization: Bearer SESSIONID

JSON structure required to post:

{
   "paymentObjId" : "a1P2E000007Tel2",
   "paymentGateway": "a1E2E000003IwFz",
   "paymentMethodId" : "a1F2E000006QOFc",
   "paymentMethodToken" : "Y7pHuq3nQs1Qza3gfgyJIGtOe65",
   "customerId:" : "001",
   "type" : "Purchase"
}

The above command returns JSON structured like this:

{
}

This endpoint provides the ability to call the payment processor directly without affecting any Fonteva objects. This endpoint requires a type to make sure the correct information is passed to the processor. The possible options are
1. Purchase
2. Capture
3. Authorize
4. Credit
5. GeneralCredit
6. PayMethodRetain

Request Detail

Parameter Required Type Description
record true ID Salesforce ID for record to pay.
paymentGateway true ID Salesforce ID for Payment Gateway to pay with.
paymentMethodId false ID Salesforce ID for Payment Method.
paymentMethodToken true string Tokenized string for payment method that will be used to charge order.
type true string Type of transaction to perform. The available options are
1. Purchase
2. Capture
3. Authorize
4. Credit
5. GeneralCredit
6. PayMethodRetain

HTTP Request

POST https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/PaymentAPIService

Price Rule

Get Price Rules

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/PriceRuleService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "ticketType": null,
            "taxInclusivePrice": 0,
            "systemModstamp": "2019-03-14T19:10:52.000Z",
            "startDate": null,
            "scheduleItem": null,
            "requiredSubscriptionPlans": null,
            "requiredSourceCodes": null,
            "requiredBadgeTypes": null,
            "priceRuleVariables": null,
            "price": 0,
            "ownerId": "0051U000003jGY2QAM",
            "numTimesUsed": 0,
            "name": "DEFAULT",
            "minQuantity": null,
            "minAssignments": null,
            "maxQuantity": null,
            "maxNumAvailable": null,
            "maxAssignments": null,
            "limitPerContact": null,
            "limitPerAccount": null,
            "lastModifiedDate": "2019-03-14T19:10:52.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "itemClass": null,
            "item": null,
            "isPromotionalPrice": false,
            "isOnSitePrice": false,
            "isMultiCurrency": false,
            "isEarlyBirdPrice": false,
            "isDeleted": false,
            "isDefault": true,
            "isActive": true,
            "id": "a1G1U000000327xUAA",
            "endDate": null,
            "currentNumAvailable": null,
            "currencyISOCode": "USD",
            "createdDate": "2019-03-14T19:10:46.000Z",
            "createdById": "0051U000003jGY2QAM"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "ticketType": null,
            "taxInclusivePrice": 0,
            "systemModstamp": "2019-03-14T19:34:03.000Z",
            "startDate": null,
            "scheduleItem": null,
            "requiredSubscriptionPlans": null,
            "requiredSourceCodes": null,
            "requiredBadgeTypes": null,
            "priceRuleVariables": null,
            "price": 0,
            "ownerId": "0051U000003jGY2QAM",
            "numTimesUsed": 0,
            "name": "DEFAULT",
            "minQuantity": null,
            "minAssignments": null,
            "maxQuantity": null,
            "maxNumAvailable": null,
            "maxAssignments": null,
            "limitPerContact": null,
            "limitPerAccount": null,
            "lastModifiedDate": "2019-03-14T19:34:03.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "itemClass": null,
            "item": null,
            "isPromotionalPrice": false,
            "isOnSitePrice": false,
            "isMultiCurrency": false,
            "isEarlyBirdPrice": false,
            "isDeleted": false,
            "isDefault": true,
            "isActive": true,
            "id": "a1G1U0000003282UAA",
            "endDate": null,
            "currentNumAvailable": null,
            "currencyISOCode": "USD",
            "createdDate": "2019-03-14T19:33:58.000Z",
            "createdById": "0051U000003jGY2QAM"
        }
    ]
}

This endpoint retrieves Price Rules (OrderApi_Price_Rule_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/PriceRuleService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Receipt

Get Receipts

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/ReceiptService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "type": "Payment",
            "total": 1010.6,
            "sourceCode": null,
            "shippingStreet": "2136 Lee Highway",
            "shippingState": "VA",
            "shippingPostalCode": "22201",
            "shippingCountry": "United States",
            "shippingContact": "SomeQA LastQA",
            "shippingCity": "Arlington",
            "salesOrder": "a1N1U00000039S1UAI",
            "refund": false,
            "referenceNumber": "HFx0EJPQh5dj6gNpEnwS3e50Qzr",
            "receiptLines": null,
            "receiptDate": "2019-02-11",
            "receipt": null,
            "processRefund": false,
            "postedDate": "2019-02-11",
            "paymentType": "Credit Card",
            "paymentMethodDescription": "VISA **1111 (1/2021)",
            "paymentMethod": null,
            "paymentGateway": "a1C1U000000qG2OUAU",
            "name": "0000001616",
            "memo": "Sales Order #000005905",
            "isRefund": false,
            "isPosted": true,
            "isPayment": true,
            "id": "a1I1U000001DrjxUAC",
            "gatewayTransactionId": "52",
            "epayment": "a121U0000002hhgQAA",
            "entity": "Contact",
            "depositAccount": "a131U0000003jcKQAQ",
            "customer": null,
            "currencyISOCode": "USD",
            "contact": null,
            "calculateShippingDetails": false,
            "calculateMemo": true,
            "calculateBillingDetails": false,
            "businessGroup": "a0q1U0000003EvpQAE",
            "billingStreet": "2136 Lee Highway",
            "billingState": "VA",
            "billingPostalCode": "22201",
            "billingCountry": "United States",
            "billingContact": "SomeQA LastQA",
            "billingCity": "Arlington",
            "batch": null,
            "balance": 0,
            "appliedAmount": 1010.6,
            "actionInformation": "{\n  \"actionLabel\" : \"Event\",\n  \"actionLinkTarget\" : \"/apex/eventapi__router?event=a1i1U0000011YCdQAM\"\n}"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "type": "Payment",
            "total": 1020.6,
            "sourceCode": null,
            "shippingStreet": "2136 Lee Highway",
            "shippingState": "VA",
            "shippingPostalCode": "22201",
            "shippingCountry": "United States",
            "shippingContact": "SomeQA LastQA",
            "shippingCity": "Arlington",
            "salesOrder": "a1N1U00000039S6UAI",
            "refund": false,
            "referenceNumber": "4CPIoo5fYBSXabqDb1M87T1OJiA",
            "receiptLines": null,
            "receiptDate": "2019-02-11",
            "receipt": null,
            "processRefund": false,
            "postedDate": "2019-02-11",
            "paymentType": "Credit Card",
            "paymentMethodDescription": "VISA **1111 (1/2022)",
            "paymentMethod": null,
            "paymentGateway": "a1C1U000000qG2OUAU",
            "name": "0000001617",
            "memo": "Sales Order #000005906",
            "isRefund": false,
            "isPosted": true,
            "isPayment": true,
            "id": "a1I1U000001Drk2UAC",
            "gatewayTransactionId": "47",
            "epayment": "a121U0000002hhlQAA",
            "entity": "Contact",
            "depositAccount": "a131U0000003jcKQAQ",
            "customer": null,
            "currencyISOCode": "USD",
            "contact": null,
            "calculateShippingDetails": false,
            "calculateMemo": true,
            "calculateBillingDetails": false,
            "businessGroup": "a0q1U0000003EvpQAE",
            "billingStreet": "2136 Lee Highway",
            "billingState": "VA",
            "billingPostalCode": "22201",
            "billingCountry": "United States",
            "billingContact": "SomeQA LastQA",
            "billingCity": "Arlington",
            "batch": null,
            "balance": 0,
            "appliedAmount": 1020.6,
            "actionInformation": "{\n  \"actionLabel\" : \"Event\",\n  \"actionLinkTarget\" : \"/apex/eventapi__router?event=a1i1U0000011YCdQAM\"\n}"
        }
    ]
}

This endpoint retrieves Receipts (OrderApi_Receipt_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/ReceiptService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Receipt Line

Get Receipt Lines

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/ReceiptLineService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "parentItem": "a181U0000002EGdQAM",
            "packageItem": null,
            "numberOfFreeItems": null,
            "name": "000000000",
            "minimumQuantity": 1,
            "maximumQuantityPerItem": null,
            "maximumQuantity": null,
            "markForDelete": null,
            "itemPrice": null,
            "itemName": null,
            "item": "a181U0000002EHRQA2",
            "isRequired": false,
            "isRecommended": false,
            "isMultiCurrency": false,
            "isGroup": false,
            "id": "a1B1U0000016N17UAE",
            "groupInstructionWrapper": {
                "id": "a1B1U0000016N17UAE",
                "groupInstructionsText": null
            },
            "groupInstructionsText": null,
            "groupHeader": null,
            "displayOrder": 0,
            "displayItem": false,
            "disableQuantity": null,
            "currencyISOCode": "USD",
            "childPackageItems": null,
            "calculatePricing": false
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "parentItem": "a181U0000002EGdQAM",
            "packageItem": null,
            "numberOfFreeItems": null,
            "name": "000000001",
            "minimumQuantity": 1,
            "maximumQuantityPerItem": null,
            "maximumQuantity": null,
            "markForDelete": null,
            "itemPrice": null,
            "itemName": null,
            "item": "a181U0000002EHUQA2",
            "isRequired": false,
            "isRecommended": false,
            "isMultiCurrency": false,
            "isGroup": false,
            "id": "a1B1U0000016N18UAE",
            "groupInstructionWrapper": {
                "id": "a1B1U0000016N18UAE",
                "groupInstructionsText": null
            },
            "groupInstructionsText": null,
            "groupHeader": null,
            "displayOrder": 0,
            "displayItem": false,
            "disableQuantity": null,
            "currencyISOCode": "USD",
            "childPackageItems": null,
            "calculatePricing": false
        }
    ]
}

This endpoint retrieves Receipt Lines (OrderApi_Receipt_Line_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/ReceiptLineService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Refund

Post Refund

Verb: POST
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/RefundService
Authorization: Bearer SESSIONID

JSON structure required to post:

[
    {
        "id": "a1I1U0000025Nx0UAE"
    }
]

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "type": null,
            "total": null,
            "sourceCode": null,
            "shippingStreet": null,
            "shippingState": null,
            "shippingPostalCode": null,
            "shippingCountry": null,
            "shippingContact": null,
            "shippingCity": null,
            "salesOrder": null,
            "refund": null,
            "referenceNumber": null,
            "receiptLines": null,
            "receiptDate": null,
            "receipt": null,
            "processRefund": true,
            "postedDate": null,
            "paymentType": null,
            "paymentMethodDescription": null,
            "paymentMethod": null,
            "paymentGateway": null,
            "name": null,
            "memo": null,
            "isRefund": null,
            "isPosted": true,
            "isPayment": null,
            "id": "a1I1U0000025Nx0UAE",
            "gatewayTransactionId": null,
            "epayment": null,
            "entity": null,
            "depositAccount": null,
            "customer": null,
            "currencyISOCode": null,
            "contact": null,
            "calculateShippingDetails": null,
            "calculateMemo": null,
            "calculateBillingDetails": null,
            "businessGroup": null,
            "billingStreet": null,
            "billingState": null,
            "billingPostalCode": null,
            "billingCountry": null,
            "billingContact": null,
            "billingCity": null,
            "batch": null,
            "balance": null,
            "appliedAmount": null,
            "actionInformation": null
        }
    ]
}

This endpoint will process a refund and call the payment processor to credit the payment method. The endpoint takes an array of Receipt IDs that need to be refunded.

Request Detail

Parameter Required Type Description
id true ID Salesforce ID for receipt to refund.

HTTP Request

POST https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/RefundService

Scheduled Payment

Get Scheduled Payments

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/ScheduledPaymentService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "token": "M8l06pb3enmSwpXCXAVXMcv1CWe",
            "term": null,
            "systemMessage": null,
            "succeeded": false,
            "subscription": null,
            "scheduledDate": "2019-06-12",
            "salesOrder": "a1N1U0000002gRGUAY",
            "processedDate": null,
            "paymentMethod": "a1D1U000000MUuwUAG",
            "paymentGateway": "a1C1U000000qG2OUAU",
            "paymentDescription": "Invoice #000001765",
            "name": "0000002692",
            "isProcessed": false,
            "isPaymentProcessed": false,
            "isCancelled": false,
            "invoice": "a151U000001ApGuQAK",
            "id": "a1P1U00000169kuUAA",
            "hasErrors": false,
            "ePaymentCreated": false,
            "customScheduledPayment": false,
            "currencyISOCode": "USD",
            "apiResponse": null,
            "amount": 10
        }
    ]
}

This endpoint retrieves Scheduled Payments (OrderApi_Scheduled_Payment_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/ScheduledPaymentService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Scheduled Payment Charge

Charge Scheduled Payment

Verb: POST
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/ScheduledPaymentChargeService
Authorization: Bearer SESSIONID

JSON structure required to post:

{
   "id": "a1P1U00000169kuUAA"
}

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": {
        "sObj": null,
        "fieldToPackageMap": null,
        "token": "M8l06pb3enmSwpXCXAVXMcv1CWe",
        "term": null,
        "systemMessage": "Succeeded!",
        "succeeded": true,
        "subscription": null,
        "scheduledDate": "2019-06-12",
        "salesOrder": "a1N1U0000002gRGUAY",
        "processedDate": null,
        "paymentMethod": "a1D1U000000MUuwUAG",
        "paymentGateway": "a1C1U000000qG2OUAU",
        "paymentDescription": "Invoice #000001765",
        "name": "0000002692",
        "isProcessed": true,
        "isPaymentProcessed": true,
        "isCancelled": false,
        "invoice": "a151U000001ApGuQAK",
        "id": "a1P1U00000169kuUAA",
        "hasErrors": false,
        "ePaymentCreated": true,
        "customScheduledPayment": false,
        "currencyISOCode": "USD",
        "apiResponse": "{\"sObj\":null,\"fieldToPackageMap\":{},\"transactions\":[{\"updated_at\":\"2019-07-24T01:14:47.000Z\",\"transaction_type\":\"Purchase\",\"token\":\"8ZXf73tDpM8NrpR3oAEiMHGXh0q\",\"succeeded\":true,\"storeSobject\":null,\"storeId\":null,\"state\":\"succeeded\",\"signature\":null,\"setup_updated_at\":null,\"setup_success\":null,\"setup_message\":null,\"setup_error_code\":null,\"setup_created_at\":null,\"setup_checkout_url\":null,\"retain_on_success\":false,\"reference_token\":null,\"redirect_url\":null,\"redirect_updated_at\":null,\"redirect_success\":null,\"redirect_result_uknown\":null,\"redirect_pending\":null,\"redirect_message\":null,\"redirect_fraud_review\":null,\"redirect_error_detail\":null,\"redirect_error_code\":null,\"redirect_cvv_message\":null,\"redirect_cvv_code\":null,\"redirect_created_at\":null,\"redirect_cancelled\":null,\"redirect_avs_message\":null,\"redirect_avs_code\":null,\"pending\":null,\"payment_method_token\":null,\"payment_method\":{\"zip\":\"22207\",\"year\":2020,\"verification_value\":\"\",\"updated_at\":\"2019-03-20T18:21:25.000Z\",\"token\":\"M8l06pb3enmSwpXCXAVXMcv1CWe\",\"test\":true,\"storage_state\":\"retained\",\"state\":\"VA\",\"retain_on_success\":null,\"phone\":null,\"payment_method_type\":\"credit_card\",\"month\":1,\"last_name\":\"Stamos\",\"last_four_digits\":\"1111\",\"full_name\":\"Edward Stamos\",\"first_six_digits\":\"411111\",\"first_name\":\"Edward\",\"errors\":[],\"email\":null,\"eligible_for_card_updater\":false,\"cvv\":null,\"created_at\":\"2018-11-02T11:02:09.000Z\",\"country\":\"United States\",\"city\":\"Arlington\",\"card_type\":\"visa\",\"bank_routing_number\":null,\"bank_name\":null,\"bank_account_type\":null,\"address2\":null,\"address1\":\"5550 Lee Highway\",\"account_number\":null,\"account_holder_type\":null},\"path\":null,\"order_id\":\"0000002692\",\"on_test_gateway\":true,\"message\":\"Succeeded!\",\"merchant_name_descriptor\":null,\"merchant_location_descriptor\":null,\"isMultiCurrencyOrganization\":null,\"ip\":null,\"gatewaySpecificResponseFields\":{},\"gatewaySpecificFields\":null,\"gateway_transaction_id\":\"67\",\"gateway_token\":\"EI5hAvYzZYksa9X7cuuIyyy8RIV\",\"gateway_specific_response_fields\":null,\"gateway_specific_fields\":null,\"gateway\":null,\"fields\":null,\"errors\":[],\"error_detail\":null,\"error_code\":null,\"email\":null,\"description\":null,\"cvv_message\":null,\"cvv_code\":null,\"custom_payment_type\":null,\"currency_code\":\"USD\",\"created_at\":\"2019-07-24T01:14:47.000Z\",\"checkout_url\":null,\"checkout_form\":null,\"cancelled\":null,\"callback_url\":null,\"callback_updated_at\":null,\"callback_success\":null,\"callback_result_uknown\":null,\"callback_pending\":null,\"callback_message\":null,\"callback_fraud_review\":null,\"callback_error_detail\":null,\"callback_error_code\":null,\"callback_cvv_message\":null,\"callback_cvv_code\":null,\"callback_created_at\":null,\"callback_conversations\":null,\"callback_cancelled\":null,\"callback_avs_message\":null,\"callback_avs_code\":null,\"avs_message\":null,\"avs_code\":null,\"amount\":1000,\"algorithm\":null}],\"payment_methods\":[],\"http_status_message\":\"OK\",\"http_status_code\":200,\"gateways\":[],\"gateway_specific_response_fields\":{},\"gateway_specific_fields\":{},\"errors\":[]}",
        "amount": 10
    }
}

This endpoint will process a Scheduled Payment and also create all corresponding records. The API response will be saved on the record for future use. Only the id field is required to process the payment.

Request Detail

Parameter Required Type Description
id true ID Salesforce ID for Scheduled Payment to process payment for.

HTTP Request

POST https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/ScheduledPaymentChargeService

Subscription

Get Subscriptions

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/SubscriptionService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "upgradedSubscription": null,
            "termStartDate": "2019-07-23",
            "terms": null,
            "termEndDate": "2019-12-31",
            "termAssignmentsAllowed": 0,
            "termActiveAssignments": 1,
            "subscriptionPlan": "a1W1U0000002I04UAE",
            "subscriptionManagementPageOverride": null,
            "status": "Active",
            "salesOrderLine": null,
            "renewalOverride": null,
            "paymentMethod": null,
            "nextScheduledPaymentDate": null,
            "name": "000004501",
            "itemClass": "a161U0000003uZfQAI",
            "item": "a181U0000002EHBQA2",
            "isUpgraded": false,
            "isSuspended": false,
            "isPending": false,
            "isExpired": false,
            "isCancelled": false,
            "isActive": true,
            "inGracePeriod": false,
            "id": "a1X1U000001Gew5UAC",
            "gracePeriodEndDate": null,
            "enableAutoRenew": false,
            "description": null,
            "currentTermStartDateValue": null,
            "currentTermStartDate": "2019-07-23",
            "currentTermEndDateValue": "2019-12-31",
            "currentTermEndDate": "2019-12-31",
            "contact": "0031U00000NFZqcQAH",
            "account": "0011U00000QPhxyQAD"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "upgradedSubscription": null,
            "termStartDate": "2019-07-23",
            "terms": null,
            "termEndDate": "2019-12-31",
            "termAssignmentsAllowed": 0,
            "termActiveAssignments": 1,
            "subscriptionPlan": "a1W1U0000002I04UAE",
            "subscriptionManagementPageOverride": null,
            "status": "Active",
            "salesOrderLine": null,
            "renewalOverride": null,
            "paymentMethod": null,
            "nextScheduledPaymentDate": null,
            "name": "000004513",
            "itemClass": "a161U0000003uZfQAI",
            "item": "a181U0000002EHBQA2",
            "isUpgraded": false,
            "isSuspended": false,
            "isPending": false,
            "isExpired": false,
            "isCancelled": false,
            "isActive": true,
            "inGracePeriod": false,
            "id": "a1X1U000001GeynUAC",
            "gracePeriodEndDate": null,
            "enableAutoRenew": false,
            "description": null,
            "currentTermStartDateValue": null,
            "currentTermStartDate": "2019-07-23",
            "currentTermEndDateValue": "2019-12-31",
            "currentTermEndDate": "2019-12-31",
            "contact": "0031U00000NFZqcQAH",
            "account": "0011U00000QPhxyQAD"
        }
    ]
}

This endpoint retrieves Subscriptions (OrderApi_Subscription_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/SubscriptionService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Subscription Line

Get Subscription Lines

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/SubscriptionLineService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "term": "a1L1U000001qv7TUAQ",
            "subscriptionLine": null,
            "subscription": "a1X1U000001Gew5UAC",
            "salesOrderLine": null,
            "itemClass": "a161U0000003uZfQAI",
            "item": "a181U0000002EHBQA2",
            "id": "a1V1U0000033PGWUA2"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "term": "a1L1U000001qv7YUAQ",
            "subscriptionLine": null,
            "subscription": "a1X1U000001GewAUAS",
            "salesOrderLine": "a1M1U000001dvEkUAI",
            "itemClass": "a161U0000003uZfQAI",
            "item": "a181U0000002EHBQA2",
            "id": "a1V1U0000033PGbUAM"
        }
    ]
}

This endpoint retrieves Subscription Lines (OrderApi_Subscription_Line_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/SubscriptionLineService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Subscription Plan

Get Subscription Plans

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/SubscriptionPlanService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "type": "Calendar",
            "scheduleType": "Invoice",
            "scheduleFrequency": "Monthly",
            "requirePaymentMethod": true,
            "renewalTermMonths": null,
            "prorationRule": null,
            "preTermRenewalWindow": null,
            "postTermRenewalWindow": null,
            "paymentSettingsInstructions": null,
            "name": "1 Year Calendar with Installments",
            "itemRenewalInstructions": null,
            "isDefault": null,
            "isActive": true,
            "id": "a1W1U0000002I06UAE",
            "gracePeriod": null,
            "enableSchedule": true,
            "enableAutomaticInvoicePayment": true,
            "disableRenew": false,
            "description": null,
            "calenderEndMonth": null,
            "calenderEndDay": null,
            "billCycleMonth": null,
            "billCycleDay": null,
            "autoRenewOption": "Disabled"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "type": "Calendar",
            "scheduleType": "Automatic Payment",
            "scheduleFrequency": "Monthly",
            "requirePaymentMethod": true,
            "renewalTermMonths": null,
            "prorationRule": "Monthly",
            "preTermRenewalWindow": null,
            "postTermRenewalWindow": null,
            "paymentSettingsInstructions": null,
            "name": "AutoCalenderSubscription",
            "itemRenewalInstructions": null,
            "isDefault": null,
            "isActive": true,
            "id": "a1W1U0000002I05UAE",
            "gracePeriod": null,
            "enableSchedule": true,
            "enableAutomaticInvoicePayment": false,
            "disableRenew": false,
            "description": null,
            "calenderEndMonth": null,
            "calenderEndDay": null,
            "billCycleMonth": null,
            "billCycleDay": null,
            "autoRenewOption": "Required"
        }
    ]
}

This endpoint retrieves Subscription Plans (OrderApi_Subscription_Plan_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/SubscriptionPlanService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Tax Locale

Get Tax Locales

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/TaxLocaleService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "taxLocaleField": "OrderApi__Shipping_State__c",
            "taxGLAccount": "a131U0000003jcQQAQ",
            "systemModstamp": "2019-02-04T18:01:27.000Z",
            "ownerId": "0051U000003jGY2QAM",
            "name": "DC Tax Locale",
            "localeValuesCSV": "DC",
            "lastModifiedDate": "2019-02-04T18:01:27.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "isDeleted": false,
            "id": "a1Y1U000000xaKjUAI",
            "createdDate": "2019-02-04T18:01:27.000Z",
            "createdById": "0051U000003jGY2QAM",
            "businessGroup": "a0q1U0000003EvpQAE"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "taxLocaleField": "OrderApi__Shipping_Country__c",
            "taxGLAccount": "a131U0000003jcQQAQ",
            "systemModstamp": "2019-02-04T18:01:27.000Z",
            "ownerId": "0051U000003jGY2QAM",
            "name": "Default Tax Locale",
            "localeValuesCSV": "United States, Canada",
            "lastModifiedDate": "2019-02-04T18:01:27.000Z",
            "lastModifiedById": "0051U000003jGY2QAM",
            "isDeleted": false,
            "id": "a1Y1U000000xaKiUAI",
            "createdDate": "2019-02-04T18:01:27.000Z",
            "createdById": "0051U000003jGY2QAM",
            "businessGroup": "a0q1U0000003EvpQAE"
        }
    ]
}

This endpoint retrieves Tax Locales (OrderApi_Tax_Locale_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/TaxLocaleService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Term

Get Terms

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/TermService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "termStartDate": "2019-07-23",
            "termEndDate": "2019-12-31",
            "subscriptionPlan": "a1W1U0000002I04UAE",
            "subscriptionLines": null,
            "subscription": "a1X1U000001Gew5UAC",
            "nextScheduledPaymentDate": null,
            "name": "000005080",
            "item": "a181U0000002EHBQA2",
            "isActive": true,
            "id": "a1L1U000001qv7TUAQ",
            "contact": "0031U00000NFZqcQAH",
            "cancellationRequested": false,
            "assignmentsAllowed": 0,
            "assignments": null,
            "activeAssignments": 1,
            "account": "0011U00000QPhxyQAD"
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "termStartDate": "2019-07-23",
            "termEndDate": "2019-12-31",
            "subscriptionPlan": "a1W1U0000002I04UAE",
            "subscriptionLines": null,
            "subscription": "a1X1U000001GewAUAS",
            "nextScheduledPaymentDate": null,
            "name": "000005081",
            "item": "a181U0000002EHBQA2",
            "isActive": true,
            "id": "a1L1U000001qv7YUAQ",
            "contact": "0031U0000093uKpQAI",
            "cancellationRequested": false,
            "assignmentsAllowed": 0,
            "assignments": null,
            "activeAssignments": 1,
            "account": "0011U00000BmsrMQAR"
        }
    ]
}

This endpoint retrieves Terms (OrderApi_Renewal_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/TermService

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Venue

Get Venues

Verb: GET
Host: MY-INSTANCE.salesforce.com
URI : /services/apexrest/FDService/VenueService
Authorization: Bearer SESSIONID

The above command returns JSON structured like this:

{
    "statusMessage": null,
    "statusCode": null,
    "metadata": {},
    "errors": [],
    "errorMap": null,
    "data": [
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "website": null,
            "name": "AutoVenue",
            "locationLongitude": null,
            "locationLatitude": null,
            "isPrimaryVenue": false,
            "imageUrl": null,
            "id": "a221U000000N6E8QAK",
            "htmlDescription": null,
            "event": "a1i1U0000011YCVQA2",
            "displayMap": false,
            "addressObj": {
                "street_number": null,
                "street_name": "2343 South Meade Street",
                "province": "VA",
                "postal_code": "22202",
                "country": "United States",
                "city": "Arlington"
            }
        },
        {
            "sObj": null,
            "fieldToPackageMap": null,
            "website": null,
            "name": "Carey.Leannon",
            "locationLongitude": null,
            "locationLatitude": null,
            "isPrimaryVenue": false,
            "imageUrl": null,
            "id": "a221U000000MzJvQAK",
            "htmlDescription": null,
            "event": "a1i1U0000011YCaQAM",
            "displayMap": false,
            "addressObj": {
                "street_number": null,
                "street_name": "5550 Columbia Pike",
                "province": "VA",
                "postal_code": "22204",
                "country": "United States",
                "city": "Arlington"
            }
        }
    ]
}

This endpoint retrieves Venues (EventApi_Venue_c).

Response Detail

Parameter Type Description
id ID Salesforce ID for record.

HTTP Request

GET https://MY-INSTANCE.salesforce.com/services/apexrest/FDService/Venueervice

Query Parameters

Search Request can be provided to further filter these results as query parameters.

Errors

The Fonteva Service API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your session ID is wrong.
403 Forbidden -- The object/record requested is hidden for administrators only.
405 Method Not Allowed -- You tried to access a service with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.