Table of Contents
Overview
Purpose
The purpose of the GoToBilling (GTB) SOAP Web Service is to provide an easy set methods for sending and receiving information from GTB in the form of SOAP requests. This allows you have a readily available platform integrating many current applications with GTB.
...
The MerchantAuth complex type allows for the delivery of the client credentials to authorize service requests.
MerchantAuth Fields
| Field Name | Required (R); Optional (O); Conditional (C); Read Only (RO) | Data Type & Length | Description & Field Values |
|---|
| **DEPRECATED** | |||
**DEPRECATED** | |||
| access_token | O | string | Valid OAuth access token. |
| access_key | O or CR | string | Provide API access key pair parameters in lieu of standard MerchantAuth fields - CONDITIONALLY REQUIRED: if access_key parameter is supplied, access_secret parameter must also be supplied. For more information on obtaining an API access key, see: Managing API Access Keys |
| access_secret | O or CR | string | Provide API access key pair parameters in lieu of standard MerchantAuth fields - CONDITIONALLY REQUIRED: if access_key parameter is supplied, access_secret parameter must also be supplied. For more information on obtaining an API access key, see: Managing API Access Keys |
| source_description | O | string | Description of the source originating the request. |
| module_description | O | string | Description of the module originating the request. |
CustomerInfo
Customers or Customer Records are the individual people or companies that are customers to the Business(MID) we are working with. Typical customer data is Name, Address, Phone number etc. There are two unique fields in GTB that help identify customers. More will be explained below but one is a unique internal ID created by GTB called customer_id and the other one is created externally by the business called customer_name. The customer_name created by the business allows them to use a unique value from their accounting or other customer service systems so they can tie their data to the data in GTB.
CustomerInfo Fields
| Field Name | Required (R); Optional (O); Conditional (C); Read Only (RO) | Data Type & Length | Description & Field Values |
|---|---|---|---|
| customer_id | C | String (50) | A unique customer identifier set by GTB. |
| first_name | C | String (50) | Required if display_as='contact' |
| last_name | C | String (50) | Required if display_as='contact' |
| customer_name | R | String (100) | Externally defined unique field for each Customer. This is a free-form identifier that is created by the user to allow matching of customers by existing customer numbers in accounting or other customer databases and systems. This field MUST be unique in order for many other functions and features the customer may use. |
| display_as | R | String (50) | Values: 'company' or 'contact'. Defaults to contact if not recognized. |
| company | C | String (50) | Required if display_as='company' |
| address1 | O | String (100) | |
| address2 | O | String (50) | |
| city | O | String (50) | |
| state | O | String (2) | |
| zip | O | String (20) | |
| phone | O | String (50) | |
| O | String (100) | ||
| ssn | O | String (50) | |
| dl_number | O | String (20) | |
| dl_state | O | String (2) | |
| notes | O | String | |
| active | R | Boolean | Determines whether a customer record is Active or Inactive. Inactive customers show as grayed out within the GTB application
|
| hidden | O | Boolean | Determines whether customer record is visible or not within the main GTB app. It’s the status field that is used when a customer record is deleted but in reality the we don’t delete the customer from the database, we just make it invisible to the user.
|
| date_added | RO | String | The date the customer was originally added to GTB. YYYYMMDD format |
...
AccountInfo Fields
| Field Name | Required (R); Optional (O); Conditional (C); Read Only (RO) | Data Type & Length | Description & Field Values |
|---|---|---|---|
| account_id | C | Int | A unique identifier assigned by GTB for every Account that is added to the system. |
| customer_id | R | Int | Unique ID of the customer the account is being assigned to. |
| account_name | O | String (100) | This field allows a consumer to name their checking or credit card account to anything they want as an identifier for their account. |
| account_number | C | String (100) For credit cards it is the 16 digit card number and for Checking Accounts it is the routing and account number including all leading zeros. | |
| routing_number | C | String(9) | ABA Routing number for bank account. |
| enabled | O | Boolean | Defines whether this Account is enabled for adding transactions or not. If it is disabled, then no transactions can be done using this account within GTB.
|
| type | R | Int | Defines the account type, i.e. credit card or ACH
|
| bank_name | C | String (50) | If account type is ACH, indicates the name of the banking institution |
| cc_name | C | String (100) | Actual Name of the customer as it appears on their credit card. |
| expiration | C | String | Card expiration date. In the format: MMYY |
| cvv | C | String (4) | The 3 or 4 digit card security value on the card. When retrieving information about an account the CVV value will always be masked for security reasons. |
| cc_zip | C | String (5) | The 5 digit billing zip code associated with the card. |
| is_savings | C | Boolean | Tells you if the Checking Account is a Savings account or not.
|
| date_added | RO | String | Format: YYYYMMDD |
| date_modified | RO | String | Format:YYYYMMDD |
...
CustomField Fields
| Field Name | Required Optional Conditional Read Only (ROR); | Data Type & Length | Description & Field Values |
|---|---|---|---|
| id | R | Int | The unique identifier for the custom field as provided by GotoBilling. |
| value | R | Int | Value assigned to the custom field. |
...