Finance APIs
List of all inked accounts receivable transactions
| HTTP method | GET |
| URI | https://api.rambase.net/finance/dunning-transactions |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Maximum page size ($top) | 80 |
| Successful HTTP status code | 200 |
| API resource identifier | 4719, version 4 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $top String, optional | Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10. |
| $pageKey String, optional | Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response. |
| $filter String, optional | Use to filter the result list, see the Filtering and sorting page for more information. |
| $orderby String, optional | Use to order the result list, see the Filtering and sorting page for more information. |
| $inlinecount String, optional | Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none" |
Read more about filters and sorting on how to use filter parameters and named filters.
| AccountsReceivableTransactionId Integer | Accounts receivable transaction identifier. |
| Currency String | Three character code following the ISO 4217 standard. |
| CustomerId Integer | Customer identifier. |
| DueDate Date | Date the object is due to be paid. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth() |
| DunningId Integer | Item-/linenumber of dunning. |
| DunningJobId Integer | Dunning job identifier. |
| IsExcluded Boolean | Indicates that this specific link is excluded from the dunning. |
| Level Integer | Level of the dunning. |
| SourceReferenceRamBaseKey String | Internal RamBase identifier of the object/item. |
Read more about filters and sorting on how to use sortable parameters
| AccountsReceivableTransactionId Integer | Accounts receivable transaction identifier |
| Currency String | Three character code following the ISO 4217 standard |
| CustomerId Integer | Customer identifier |
| DueDate Date | Date the object is due to be paid |
| DunningId Integer | Item-/linenumber of dunning |
| DunningJobId Integer | Dunning job identifier |
| Level Integer | Level of the dunning |
| SourceReferenceRamBaseKey String | Internal RamBase identifier of the object/item |
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
IsExcluded
Indicates that this specific link is excluded from the dunning
>{Boolean}</IsExcluded>AccountsReceivableTransactionId
Accounts receivable transaction identifier
>{Integer}</AccountsReceivableTransactionId>DueDate
Date the object is due to be paid
>{Date}</DueDate>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Identifier of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>TotalAmount
Total amount
>{Decimal}</TotalAmount>AccountsReceivableTransactionLink
Accounts receivable transaction reference
>{String}</AccountsReceivableTransactionLink>DunningId
Item-/linenumber of dunning
>{Integer}</DunningId>SellersPaymentReference
Sellers reference to identify the object. In Norway this is typically a KID-number.
>{String}</SellersPaymentReference>Level
Level of the dunning
>{Integer}</Level>IsExcluded
Indicates that this specific dunning is excluded from the dunning job
>{Boolean}</IsExcluded>CustomerId
Customer identifier
>{Integer}</CustomerId>Name
Name of customer (name of company or surname/familyname/lastname of a person)
>{String}</Name>Firstname
Secondary name of a company or firstname of a person
>{String}</Firstname>CustomerLink
Customer reference
>{String}</CustomerLink>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>DunningJobId
Dunning job identifier
>{Integer}</DunningJobId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>DunningJobLink
Supplier invoice reference
>{String}</DunningJobLink>DunningLink
Supplier invoice reference
>{String}</DunningLink>Paging
Detailed paging information for this list.
>PageSize
Number of elements in the list, as defined in $top. Default is 10.
>{Integer}</PageSize>Position
Position of the first element in the list
>{Integer}</Position>Page
Page index
>{Integer}</Page>FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
>{String}</FirstPage>PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
>{String}</PreviousPage>NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
>{String}</NextPage>LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
>{String}</LastPage>Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
>{Integer}</Size>IsExcluded
Indicates that this specific link is excluded from the dunning
": "{Boolean}",AccountsReceivableTransactionId
Accounts receivable transaction identifier
": "{Integer}",DueDate
Date the object is due to be paid
": "{Date}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",ItemId
Identifier of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",TotalAmount
Total amount
": "{Decimal}"AccountsReceivableTransactionLink
Accounts receivable transaction reference
": "{String}"DunningId
Item-/linenumber of dunning
": "{Integer}",Status
Status of the dunning
Possible domain values can be found here
": "{Integer}",SellersPaymentReference
Sellers reference to identify the object. In Norway this is typically a KID-number.
": "{String}",Level
Level of the dunning
": "{Integer}",IsExcluded
Indicates that this specific dunning is excluded from the dunning job
": "{Boolean}",CustomerId
Customer identifier
": "{Integer}",Name
Name of customer (name of company or surname/familyname/lastname of a person)
": "{String}",Firstname
Secondary name of a company or firstname of a person
": "{String}",CustomerLink
Customer reference
": "{String}"UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"DunningJobId
Dunning job identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",DunningJobLink
Supplier invoice reference
": "{String}"DunningLink
Supplier invoice reference
": "{String}"Paging
Detailed paging information for this list.
": {PageSize
Number of elements in the list, as defined in $top. Default is 10.
": "{Integer}",Position
Position of the first element in the list
": "{Integer}",Page
Page index
": "{Integer}",FirstPage
Link to the first page in the list. $pageKey is set to FirstPageKey.
": "{String}",PreviousPage
Link to the previous page in the list. $pageKey is set to PreviousPageKey.
": "{String}",NextPage
Link to the next page in the list. $pageKey is set to NextPageKey.
": "{String}",LastPage
Link to the last page in the list. $pageKey is set to LastPageKey.
": "{String}",Size
Total number of records in the list. Use $inlinecount=allpages in the request uri to include this
": "{Integer}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 102738 HTTP 404 | Price list not found |
| Error 100055 HTTP 403 | You have only admittance to your own objects |