The REMIT API allows client applications to maintain REMIT data record sets.
This developer's guide is intended for software developers needing a technical reference for using the QBOS REST API. The information you find in this guide is written by software engineering, and is authoritative on how the API behaves.
Occasionally, we make a mistake in this documentation, or unknowingly break a feature that you depend on. If this has happened to you, we apologize! You can help us fix the issue by contacting us at: pkajaani@qbos.com. We appreciate your help.
To place any request in a QBOS API application from a third party application you need to first authenticate your user account and set/calculate values for the following request headers:
x-qbos-id, x-qbos-nonce, x-qbos-date-utc, x-qbos-hash-version, x-qbos-auth
See details in Authentication Documentation.
Custom resource (a.k.a applet) URI contains the resource vendor id in place of "/o/" in the standard object URI.
Compare:
.../v1/o/...with .../v1/{vendor_id}/...
Properties prefixed with '_' (underscore) are read-only properties. i.e. POST and PUT processing will ignore these properties.
| Name | Type | Max Length |
Numeric | Required For POST |
Filterable | Default | Description |
|---|---|---|---|---|---|---|---|
| _client_Id | bigint | Yes | NULL | This is the Data Org Id. | |||
| _owner_Id | bigint | Yes | Yes | NULL | This is the user id of the record owner. Defaults to the creatorOpid. | ||
| _creator_Opid | bigint | Yes | Yes | NULL | This is the user id of the original record submitter. | ||
| _create_Date | datetime | No | {timestamp} | Not enterable upon Insert. System sets this date upon record creation. | |||
| status_id | int | Yes | Yes | 3914 | The status id of the record. Taken from the Life Cycle statuses in ADS. | ||
| _status_Change_Date | datetime | No | NULL | Not enterable. System sets this date whenever the statusid is changed. | |||
| Transaction_Handling_Code | nvarchar | 1 | Yes | NULL |
This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column. |
||
| Amount | money | Yes | Yes | NULL | |||
| Credit_Debit_Flag | nvarchar | 1 | Yes | NULL |
This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column. |
||
| Pay_Method | nvarchar | 3 | Yes | NULL |
This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column. |
||
| Pay_Trace_Number | nvarchar | 50 | Yes | NULL | |||
| Payer_Name | nvarchar | 50 | Yes | NULL | |||
| Payer_Identifier | nvarchar | 50 | Yes | NULL | |||
| Payer_Identifier_Type | nvarchar | 2 | Yes | NULL | |||
| Payee_ID | nvarchar | 50 | Yes | NULL | |||
| Adjustment | money | Yes | Yes | NULL | |||
| Adjustment_Code | nvarchar | 50 | Yes | NULL | |||
| Process_file | bit | Yes | Yes | 0 |
This property is populated by a Type 1 Value List. Click here for the appropriate API and sample of value options for this column. |
||
| Process_status | nvarchar | 50 | Yes | NULL | |||
| Processed_On | datetime | Yes | NULL | ||||
| File_Name | nvarchar | 100 | Yes | NULL | |||
| Remit_Date | datetime | Yes | NULL | ||||
| Deposit_Date | datetime | Yes | NULL | ||||
| Payee_Name | nvarchar | 100 | Yes | NULL |
Parent and Child relations to REMIT.
Note that the only Required status on relationships that affect a POST of an object are on the parent relations. A Required status on a child relation is only meaningful when POSTing the child object.
Linking during POST: a custom object record can be linked to a parent or child record (custom or standard) during POST by including (in the payload) the realtion id paired with the parent or child object record being linked to. For example: { "REl_2616" : 1832 } Multiple links may be created in the same POST.
| Relation Id | Cardinality (Parent-to-Child) |
Required For POST |
Links Up To | Is Unary?* |
|---|---|---|---|---|
| n/a | 2147482647 | Corporate | ||
| Parent Relations ↑ REMIT ↓ Child Relations | ||||
| Relation Id | Cardinality (Parent-to-Child) |
Required **on POST of child |
Links Down To | |
| REL_2616 | 1-Many | Yes** | Contact | |
| REL_2617 | 1-Many | Yes** | Contact | |
| REL_2351 | 1-Many | Yes** | Remittance_Claim_Bundle | |
| REL_3169 | 1-Many | Remit_File_PLB_Adjustments | ||
Request data [See properties]:
Response codes:
Request data [See properties]:
Response codes:
The "id" in JSON payload is required to match the {id} in the URI to ensure that deletion requests are intended and safe
Response codes:
Response codes:
Response codes: