lib/client/sf-gate/docs/ContractsApi.md

SfGate.ContractsApi

All URIs are relative to http://sf-gate.vernonkeenan.com:8080/v1

Method	HTTP request	Description
getContracts	GET /contracts	Get a list of contracts
postContracts	POST /contracts	Add a new contract to Taxnexus

getContracts

ContractResponse getContracts(opts)

Get a list of contracts

Return a list of all available Contracts

Example

import SfGate from 'sf_gate';
let defaultClient = SfGate.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new SfGate.ContractsApi();
let opts = {
  'limit': 789, // Number | How many objects to return at one time
  'offset': 789, // Number | How many objects to skip?
  'active': true, // Boolean | Only retrieve active records?
  'contractId': "contractId_example" // String | Taxnexus Contact record ID
};
apiInstance.getContracts(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
limit	Number	How many objects to return at one time	[optional]
offset	Number	How many objects to skip?	[optional]
active	Boolean	Only retrieve active records?	[optional]
contractId	String	Taxnexus Contact record ID	[optional]

Return type

ContractResponse

Authorization

ApiKeyAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

postContracts

ContractResponse postContracts(contractsRequest)

Add a new contract to Taxnexus

Contract record to be added

Example

import SfGate from 'sf_gate';
let defaultClient = SfGate.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix = 'Token';

let apiInstance = new SfGate.ContractsApi();
let contractsRequest = new SfGate.ContractRequest(); // ContractRequest | An array of new Contract records
apiInstance.postContracts(contractsRequest, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
contractsRequest	ContractRequest	An array of new Contract records

Return type

ContractResponse

Authorization

ApiKeyAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json