Table 9. API Resources for Billing Accounts
|
|
|
|
GET |
/accounts |
None |
Returns all accounts for the current period. This information is retrieved from the billing hierarchy for a B2B user, or from a user account link table for a B2C user. |
POST |
/accounts |
billerId, type{b2b, b2c} |
Creates an account. For B2B, it also adds the account to the company's latest period of the billing hierarchy. The billing file load can override any attribute values entered. |
GET |
/accounts/{accountId} |
billerId |
Returns an account. |
PUT |
/accounts/{accountId} |
billerId |
Updates an account. |
PUT |
/accounts/{accountId} |
billerId, endDate=
now |
Cancels an account. |
DELETE |
/accounts/{accountId} |
None |
Deletes an account. |
GET |
/accounts/{accountId}/balance |
None |
Returns the current account balance. The balance can differ from the most recent statement. |
PUT |
/accounts/{accountId}/balance |
None |
Updates the current balance of the account. The current balance can differ from the most recent statement. |
POST |
/accounts/{accountId}/contacts |
None |
Creates a contact for the account. |
GET |
/accounts/{accountId}/contacts |
None |
Returns all contacts for the account. |
PUT |
/accounts/{accountId}/contacts/{contactKey} |
None |
Updates the contact for the account. <See payload>> |
DELETE |
/accounts/{accountId}/contacts/{contactKey} |
None |
Deletes the contact from the account. |
