TAG LINE
SMALL TITLE
| id | "id": 10 Type: Number This is the unique numeric identifier for the Account |
| currencyId | "currencyId": 9 Type: Number Unique identifier for the associated Currency object. |
| ownerId | "ownerId": 1 Type: Number Unique identifier for the associated Owner object. |
| name | "name": "Hello World" Type: String |
| created | "created": "2005-04-11T14:56:24" Type: Date |
| accountStatusTypeId | "accountStatusTypeId": 8 Type: Number Unique identifier for the associated AccountStatusType object. |
| billGroupId | "billGroupId": 9 Type: Number Unique identifier for the associated BillGroup object. |
| actingOwnerId | "actingOwnerId": 10 Type: Number Unique identifier for the associated Owner object. |
| lastUpdate | "lastUpdate": "2005-04-11T14:56:24" Type: Date |
| effectiveCancel | "effectiveCancel": "2005-04-11T14:56:24" Type: Date |
| invoiceDeliveryId | "invoiceDeliveryId": 25 Type: Number Unique identifier for the associated InvoiceDelivery object. |
| accountsReceivableTermsId | "accountsReceivableTermsId": 2 Type: Number Unique identifier for the associated AccountsReceivableTerms object. |
| accountTypeId | "accountTypeId": 3 Type: Number Unique identifier for the associated AccountType object. |
| billDay | "billDay": 21 Type: Number |
| accountTaxCategoryId | "accountTaxCategoryId": 5 Type: Number Unique identifier for the associated AccountTaxCategory object. |
| taxCodeId | "taxCodeId": 15 Type: Number Unique identifier for the associated TaxCode object. |
| invoicerAccountId | "invoicerAccountId": 7 Type: Number Unique identifier for the associated Account object. |
| usageInvoicerAccountId | "usageInvoicerAccountId": 15 Type: Number Unique identifier for the associated Account object. |
| taxSettingAccountId | "taxSettingAccountId": 0 Type: Number Unique identifier for the associated Account object. |
| usageBillDay | "usageBillDay": 2 Type: Number |
| isReadOnlyBillDay | "isReadOnlyBillDay": true Type: Boolean |
| isReadOnlyUsageBillDay | "isReadOnlyUsageBillDay": true Type: Boolean |
| displayName | "displayName": "Hello World" Type: String |
| createdByUserId | "createdByUserId": 14 Type: Number Unique identifier for the associated User object. |
| id | "id": 23 Type: Number |
When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.
Field List:
The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.
PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the Account object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | api/v2/Account/{id:int} |
| Delete an instance of the Account object. | |
| DELETE | api/v2/Account/{id:int}/Note |
| Delete a Note object from the Account. | |
| {id:int} | Unique identifier for the Account object. |
| GET | api/v2/Account |
| Retrieve all of the Account objects. | |
| GET | api/v2/Account/Paged |
| Retreive all of the Account objects in a paged fashion. | |
| GET | api/v2/Account/Paged/Detail |
| Retreive all of the Account objects in a paged fashion with all object details. | |
| GET | api/v2/Account/{id:int} |
| Retrieve an instance of the Account object by it's ID. | |
| {id:int} | Unique identifier for the Account object. |
| GET | api/v2/Account/{id:int}/Detail |
| Retreive all of the Detail objects for the specified Account. | |
| {id:int} | Unique identifier for the Account object. |
| GET | api/v2/Account/{id:int}/Note |
| Retreive all of the Note objects for the specified Account. | |
| {id:int} | Unique identifier for the Account object. |
| GET | api/v2/Account/{id:int}/Note/Paged |
| Retreive all of the Note objects for a specified Account. | |
| {id:int} | Unique identifier for the Account object. |
| GET | api/v2/Account/{id:int}/Note/{noteId:int} |
| Retrieve a specified Note object by it's ID for a specified Account. | |
| {id:int} | Unique identifier for the Account object. |
| PATCH | api/v2/Account/{id:int} |
| Update the Account object and optionally make changes to any child objects. | |
| POST | api/v2/Account |
| Create a new instance of the Account object. | |
| POST | api/v2/Account/{id:int}/Note |
| Create a new instance of a Note object that belongs to the Account. | |
| {id:int} | Unique identifier for the Account object. |
| POST | api/v2/Account/{id:int}/Patch |
| Create a new instance of a Patch object that belongs to the Account. | |
| {id:int} | Unique identifier for the Account object. |
| PUT | api/v2/Account/{id:int} |
| Update an existing instance of the Account object. | |
| PUT | api/v2/Account/{id:int}/Note |
| Update an existing instance of a Note object that belongs to the Account. | |
| {id:int} | Unique identifier for the Account object. |