API

Procurement APIs

GET procurement/credit-notes

List of supplier credit notes

HTTP method GET
URI https://api.rambase.net/procurement/credit-notes
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 631, version 12

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.

Format:
1
1

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"
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.
$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.

InfoNotification() Named filter Supplier credit note with notifications of category I (Information)
MyCreditNotes() Named filter Supplier credit notes current user is assigned to
ValidatedRegistrable() Named filter Pending registration supplier credit notes
AccountingPeriod Integer Accounting period. Available macros: currentPeriod(), previousPeriod()
Assignee Integer The user who has been assigned to work with this object. Available macros: currentUser()
BuyersReferenceNumber String Buyers reference number.
ContainingNotificationMessage String Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language.
ContainingNotificationTypeId Integer Notification type identifier.
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Currency String Three character code following the ISO 4217 standard.
DueDate Date Date the object is due to be paid. Available macros: today(), yesterday(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
IntercompanyCode String Intercompany database the supplier belongs to.
Location String Unique abbreviation/short name of the location.
Name String Name of supplier (name of company or surname/familyname/lastname of a person).
Note String Additional information regarding the object (free text). This note might be visible to customers/suppliers.
Status String Status of supplier credit note.
SupplierCreditNoteId Integer Supplier credit note identifier.
SupplierId Integer Customer identifier.
SuppliersInvoiceNumber String Suppliers/sellers reference number. Typically to an external system.
SuppliersReference String Suppliers/sellers reference. Typically a person.
VATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).

Read more about filters and sorting on how to use sortable parameters

AccountingPeriod Integer Accounting period
Assignee Integer The user who has been assigned to work with this object.
BuyersReferenceNumber String Buyers reference number
ContainingNotificationMessage String Show all transaction documents containing notifications. Note that search will be for messages in company language, and not in user language.
ContainingNotificationTypeId Integer Notification type identifier
CreatedAt Datetime Date and time of creation
Currency String Three character code following the ISO 4217 standard
DueDate Date Date the object is due to be paid
IntercompanyCode String Intercompany database the supplier belongs to.
Location String Unique abbreviation/short name of the location
Name String Name of supplier (name of company or surname/familyname/lastname of a person)
Note String Additional information regarding the object (free text). This note might be visible to customers/suppliers.
Status String Status of supplier credit note
SupplierCreditNoteId Integer Supplier credit note identifier
SupplierId Integer Customer identifier
SuppliersInvoiceNumber String Suppliers/sellers reference number. Typically to an external system.
SuppliersReference String Suppliers/sellers reference. Typically a person.
VATRegistrationNumber String Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

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.

Format:
1
<SupplierCreditNotes>
2
     <SupplierCreditNote>
3
          <SupplierCreditNoteId
SupplierCreditNoteId

Supplier credit note identifier

>{Integer}</SupplierCreditNoteId>
4
          <Status
Status

Status of supplier credit note

Possible domain values can be found here

>{String}</Status>
5
          <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
          <SuppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

>{String}</SuppliersReference>
7
          <SuppliersInvoiceNumber
SuppliersInvoiceNumber

Suppliers/sellers reference number. Typically to an external system.

>{String}</SuppliersInvoiceNumber>
8
          <BuyersReferenceNumber
BuyersReferenceNumber

Buyers reference number

>{String}</BuyersReferenceNumber>
9
          <IssueDate
IssueDate

Date when the document was issued.

>{Date}</IssueDate>
10
          <ReceivedDate
ReceivedDate

Date when the document was received.

>{Date}</ReceivedDate>
11
          <RegistrationDate
RegistrationDate

Date of registration

>{Date}</RegistrationDate>
12
          <Currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

>{String}</Currency>
13
          <PendingReception
PendingReception

Indicates if the supplier credit note is pending reception

>{Boolean}</PendingReception>
14
          <NumberOfAttachements
NumberOfAttachements

Number of attachements for this supplier credit note

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.NumberOfAttachements in your request URI to get this field

>{Integer}</NumberOfAttachements>
15
          <AccountingPeriod>
16
               <AccountingPeriodId
AccountingPeriodId

Accounting period identifier

>{Integer}</AccountingPeriodId>
17
               <Period
Period

Accounting period

>{Integer}</Period>
18
               <AccountingPeriodLink
AccountingPeriodLink

Accounting period reference

>{String}</AccountingPeriodLink>
19
          </AccountingPeriod>
20
          <Assignee
Assignee

The user who has been assigned to work with this object.

>
21
               <UserId
UserId

User identifier

>{Integer}</UserId>
22
               <Name
Name

Name of the user

>{String}</Name>
23
               <FirstName
FirstName

First name of the user

>{String}</FirstName>
24
               <UserLink
UserLink

User reference

>{String}</UserLink>
25
          </Assignee>
26
          <Supplier>
27
               <SupplierId
SupplierId

RamBase supplier identifier

>{Integer}</SupplierId>
28
               <Name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

>{String}</Name>
29
               <Firstname
Firstname

Firstname/givenname if the supplier is a person

>{String}</Firstname>
30
               <Intercompany>
31
                    <Code
Code

Intercompany database the supplier belongs to.

>{String}</Code>
32
               </Intercompany>
33
               <SupplierLink
SupplierLink

Supplier reference

>{String}</SupplierLink>
34
          </Supplier>
35
          <Totals>
36
               <Currency
Currency

Three character code following the ISO 4217 standard

>{String}</Currency>
37
               <SubTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

>{Decimal}</SubTotalAmount>
38
               <VATAmount
VATAmount

Total value added tax in object currency.

>{Decimal}</VATAmount>
39
               <TotalAmount
TotalAmount

The total amount in object currency, including VAT

>{Decimal}</TotalAmount>
40
          </Totals>
41
          <Payment>
42
               <DueDate
DueDate

Date the object is due to be paid

>{Date}</DueDate>
43
          </Payment>
44
          <VATDetails>
45
               <VATEntity>
46
                    <VATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

>{String}</VATRegistrationNumber>
47
               </VATEntity>
48
          </VATDetails>
49
          <HighlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

>
50
               <NotificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

>{Integer}</NotificationId>
51
               <Status
Status

Status of the notification

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

>{Integer}</Status>
52
               <CreatedAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

>{Datetime}</CreatedAt>
53
               <Message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

>{String}</Message>
54
               <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

>{String}</TranslatedMessage>
55
               <NotificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

>
56
                    <NotificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeId>
57
                    <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

>{String}</Category>
58
                    <NotificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

>{String}</NotificationTypeLink>
59
               </NotificationType>
60
               <NotificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

>{String}</NotificationLink>
61
          </HighlightedNotification>
62
          <SupplierCreditNoteLink
SupplierCreditNoteLink

Supplier credit note reference

>{String}</SupplierCreditNoteLink>
63
     </SupplierCreditNote>
64
     <Paging
Paging

Detailed paging information for this list.

>
65
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
66
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
67
          <Page
Page

Page index

>{Integer}</Page>
68
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</FirstPageKey>
69
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
70
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</PreviousPageKey>
71
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
72
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</NextPageKey>
73
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
74
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

>{String}</LastPageKey>
75
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
76
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
77
     </Paging>
78
</SupplierCreditNotes>
1
{
2
     "supplierCreditNotes": [
3
          {
4
               "supplierCreditNoteId
SupplierCreditNoteId

Supplier credit note identifier

": "{Integer}",
5
               "status
Status

Status of supplier credit note

Possible domain values can be found here

": "{String}",
6
               "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
               "suppliersReference
SuppliersReference

Suppliers/sellers reference. Typically a person.

": "{String}",
8
               "suppliersInvoiceNumber
SuppliersInvoiceNumber

Suppliers/sellers reference number. Typically to an external system.

": "{String}",
9
               "buyersReferenceNumber
BuyersReferenceNumber

Buyers reference number

": "{String}",
10
               "issueDate
IssueDate

Date when the document was issued.

": "{Date}",
11
               "receivedDate
ReceivedDate

Date when the document was received.

": "{Date}",
12
               "registrationDate
RegistrationDate

Date of registration

": "{Date}",
13
               "currency
Currency

Three character code following the ISO 4217 standard

Possible domain values can be found here

": "{String}",
14
               "pendingReception
PendingReception

Indicates if the supplier credit note is pending reception

": "{Boolean}",
15
               "numberOfAttachements
NumberOfAttachements

Number of attachements for this supplier credit note

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.NumberOfAttachements in your request URI to get this field

": "{Integer}",
16
               "accountingPeriod": {
17
                    "accountingPeriodId
AccountingPeriodId

Accounting period identifier

": "{Integer}",
18
                    "period
Period

Accounting period

": "{Integer}",
19
                    "accountingPeriodLink
AccountingPeriodLink

Accounting period reference

": "{String}"
20
               },
21
               "assignee
Assignee

The user who has been assigned to work with this object.

": {
22
                    "userId
UserId

User identifier

": "{Integer}",
23
                    "name
Name

Name of the user

": "{String}",
24
                    "firstName
FirstName

First name of the user

": "{String}",
25
                    "userLink
UserLink

User reference

": "{String}"
26
               },
27
               "supplier": {
28
                    "supplierId
SupplierId

RamBase supplier identifier

": "{Integer}",
29
                    "name
Name

Name of supplier (name of company or surname/familyname/lastname of a person)

": "{String}",
30
                    "firstname
Firstname

Firstname/givenname if the supplier is a person

": "{String}",
31
                    "intercompany": {
32
                         "code
Code

Intercompany database the supplier belongs to.

": "{String}"
33
                    },
34
                    "supplierLink
SupplierLink

Supplier reference

": "{String}"
35
               },
36
               "totals": {
37
                    "currency
Currency

Three character code following the ISO 4217 standard

": "{String}",
38
                    "subTotalAmount
SubTotalAmount

Total amount of the object in object currency, excluding VAT.

": "{Decimal}",
39
                    "vATAmount
VATAmount

Total value added tax in object currency.

": "{Decimal}",
40
                    "totalAmount
TotalAmount

The total amount in object currency, including VAT

": "{Decimal}"
41
               },
42
               "payment": {
43
                    "dueDate
DueDate

Date the object is due to be paid

": "{Date}"
44
               },
45
               "vATDetails": {
46
                    "vATEntity": {
47
                         "vATRegistrationNumber
VATRegistrationNumber

Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)

": "{String}"
48
                    }
49
               },
50
               "highlightedNotification
HighlightedNotification

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

": {
51
                    "notificationId
NotificationId

Notification identifier

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

": "{Integer}",
52
                    "status
Status

Status of the notification

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

": "{Integer}",
53
                    "createdAt
CreatedAt

Date and time of creation

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

": "{Datetime}",
54
                    "message
Message

The message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

": "{String}",
55
                    "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

": "{String}",
56
                    "notificationType
NotificationType

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

": {
57
                         "notificationTypeId
NotificationTypeId

Notification type identifier

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

": "{String}",
58
                         "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

": "{String}",
59
                         "notificationTypeLink
NotificationTypeLink

Notification type reference

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

": "{String}"
60
                    },
61
                    "notificationLink
NotificationLink

Notification reference

This field is greyed out because it is an expandable field. You have to add $expand=SupplierCreditNote.HighlightedNotification in your request URI to get this field

": "{String}"
62
               },
63
               "supplierCreditNoteLink
SupplierCreditNoteLink

Supplier credit note reference

": "{String}"
64
          }
65
     ],
66
     "paging
Paging

Detailed paging information for this list.

": {
67
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
68
          "position
Position

Position of the first element in the list

": "{Integer}",
69
          "page
Page

Page index

": "{Integer}",
70
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
71
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
72
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
73
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
74
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
75
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
76
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

This field is greyed out because it is an expandable field. You have to add $expand=PagingDetails in your request URI to get this field

": "{String}",
77
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
78
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
79
     }
80
}

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 100147 HTTP 404 Notification type not found