Procurement APIs
Creates a new supplier credit note
| HTTP method | POST |
| URI | https://api.rambase.net/procurement/credit-notes |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 201 |
| API resource identifier | 4460, version 2 |
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.
SuppliersInvoiceNumber
Suppliers/sellers reference number. Typically to an external system.
This field is optional.
>{String}</SuppliersInvoiceNumber>SuppliersPaymentReference
Sellers reference to identify the object. In Norway this is typically a KID-number.
This field is optional.
>{String}</SuppliersPaymentReference>IssueDate
Required/mandatory field
Date when the document was issued.
>{Date}</IssueDate>Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
>{String}</Currency>SupplierId
Required/mandatory field
RamBase supplier identifier
Minimum value: 100
>{Integer}</SupplierId>Payment
This field is optional.
>DueDate
Date the object is due to be paid
This field is optional.
>{Date}</DueDate>SuppliersInvoiceNumber
Suppliers/sellers reference number. Typically to an external system.
This field is optional.
": "{String}",SuppliersPaymentReference
Sellers reference to identify the object. In Norway this is typically a KID-number.
This field is optional.
": "{String}",IssueDate
Required/mandatory field
Date when the document was issued.
": "{Date}",Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
": "{String}",SupplierId
Required/mandatory field
RamBase supplier identifier
Minimum value: 100
": "{Integer}"Payment
This field is optional.
": {DueDate
Date the object is due to be paid
This field is optional.
": "{Date}"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.
| $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 |
| $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. |
| $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] |
| $showCustomFields Boolean, optional | Set to "true" to include custom fields. Default value is false. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
SupplierCreditNoteId
Supplier credit note identifier
>{Integer}</SupplierCreditNoteId>Status
Status of supplier credit note
Possible domain values can be found here
>{String}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>SuppliersReference
Suppliers/sellers reference. Typically a person.
>{String}</SuppliersReference>SuppliersInvoiceNumber
Suppliers/sellers reference number. Typically to an external system.
>{String}</SuppliersInvoiceNumber>SuppliersPaymentReference
Sellers reference to identify the object. In Norway this is typically a KID-number.
>{String}</SuppliersPaymentReference>BuyersReferenceNumber
Buyers reference number
>{String}</BuyersReferenceNumber>IssueDate
Date when the document was issued.
>{Date}</IssueDate>ReceivedDate
Date when the document was received.
>{Date}</ReceivedDate>RegistrationDate
Date of registration
>{Date}</RegistrationDate>Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
>{String}</Currency>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
>{String}</Note>PendingReception
Indicates if the supplier credit note is pending reception
>{Boolean}</PendingReception>ShipToAttention
Attention of the ship to address. When changing ship to address, the ShipToAttention will be overridden by the attention of the new ship to address.
>{String}</ShipToAttention>InvoiceAddressAttention
Attention of the correspondence address. When changing correspondence address, the CorrespondenceAddressAttention will be overridden by the attention of the new correspondence address.
>IsSubjectedToSplitPayment
Indicates if an customer / supplier invoice and / or credit note is subjected to split payment
>{Boolean}</IsSubjectedToSplitPayment>PurchaseOutsideEU
Purchase was from outside of EU. Used for the JPK files for "Shortened import procedure outside of EU".
>{Boolean}</PurchaseOutsideEU>AccountingPeriodId
Accounting period identifier
>{Integer}</AccountingPeriodId>Period
Accounting period
>{Integer}</Period>AccountingPeriodLink
Accounting period reference
>{String}</AccountingPeriodLink>LocationId
Location identifier
>{Integer}</LocationId>Name
Name of location
>{String}</Name>ShortName
Unique abbreviation/short name of the location
>{String}</ShortName>LocationLink
Location reference
>{String}</LocationLink>Assignee
The user who has been assigned to work with this object.
>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>SupplierId
RamBase supplier identifier
>{Integer}</SupplierId>Name
Name of supplier (name of company or surname/familyname/lastname of a person)
>{String}</Name>Firstname
Firstname/givenname if the supplier is a person
>{String}</Firstname>LegalEntityIdentifier
The suppliers unique enterprise/organization number.
>{String}</LegalEntityIdentifier>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
>{String}</VATRegistrationNumber>Code
Intercompany database the supplier belongs to.
>{String}</Code>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>SupplierLink
Supplier reference
>{String}</SupplierLink>SupplierBankAccountId
Supplier bank account identifier
>{Integer}</SupplierBankAccountId>Name
Name of bank account
>{String}</Name>AccountNumber
Account number used to identify the bank account
>{String}</AccountNumber>SWIFTCode
The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.
>{String}</SWIFTCode>InternationalBankAccountNumber
The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.
>{String}</InternationalBankAccountNumber>Address
Address of the bank associated with the bank account
>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>SupplierBankAccountLink
Supplier bank account reference
>{String}</SupplierBankAccountLink>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>FreightAmount
Freight amount in transaction document's currency
>{Decimal}</FreightAmount>FeeAmount
Fee amount in transaction document's currency
>{Decimal}</FeeAmount>RoundOffAmount
Round-off amount in transaction document's currency
>{Decimal}</RoundOffAmount>SubTotalAmount
Total amount of the object in object currency, excluding VAT.
>{Decimal}</SubTotalAmount>VATAmount
Total value added tax in object currency.
>{Decimal}</VATAmount>TotalAmount
The total amount in object currency, including VAT
>{Decimal}</TotalAmount>VATRoundOffAmount
VAT round-off amount in transaction document's currency
>{Decimal}</VATRoundOffAmount>Currency
Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.
>{String}</Currency>ExchangeRate
The exchange rate used in convertion
>{Decimal}</ExchangeRate>FreightAmount
Freight amount in company currency.
>{Decimal}</FreightAmount>FeeAmount
Fee amount in company currency
>{Decimal}</FeeAmount>RoundOffAmount
Round-off amount in company currency
>{Decimal}</RoundOffAmount>SubTotalAmount
Total amount of the object in company currency, excluding VAT.
>{Decimal}</SubTotalAmount>VATAmount
Value added tax amount in company currency.
>{Decimal}</VATAmount>TotalAmount
The total amount in company currency, including VAT.
>{Decimal}</TotalAmount>VATRoundOffAmount
VAT round-off amount in company currency
>{Decimal}</VATRoundOffAmount>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
>{String}</Firstname>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>Database
Database of the object
>{String}</Database>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectType
Type of object
>{String}</ObjectType>ObjectLink
API reference to the object
>{String}</ObjectLink>RamBaseKey
Internal RamBase identifier of the object/item
>{String}</RamBaseKey>AddressId
Address identifier
>{Integer}</AddressId>Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
>{String}</Name>AddressLine1
First address line
>{String}</AddressLine1>AddressLine2
Second address line
>{String}</AddressLine2>PostalCode
Postalcode/Postcode/ZIP
>{String}</PostalCode>City
City/town/village
>{String}</City>Region
Region/province/state
>{String}</Region>CountryCode
Two-character code (ISO 3166) identifying the country.
>{String}</CountryCode>Country
English name of country.
>{String}</Country>AddressLink
Supplier address reference
>{String}</AddressLink>PaymentTerms
Terms of payment. Defaut value is retrieved from the supplier.
Possible domain values can be found here
>{String}</PaymentTerms>PaymentMethod
Method of payment. Default value is retrieved from the supplier.
Possible domain values can be found here
>{String}</PaymentMethod>DueDate
Date the object is due to be paid
>{Date}</DueDate>PostponeVAT
Indicates that the VAT posting should be postponed
>{Boolean}</PostponeVAT>VATType
Type of value added tax
>{String}</VATType>VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Possible domain values can be found here
>{String}</VATHandling>VATRate
Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.
>{Decimal}</VATRate>VATDate
Date of VAT posting. Currency rate calculation use this date.
>{Date}</VATDate>VATPeriod
Accounting period this VAT posting belongs to
>{Integer}</VATPeriod>DefaultVATPercent
Value added tax percent.
>{Decimal}</DefaultVATPercent>VATCodeDefinitionId
VAT code identifier
>{Integer}</VATCodeDefinitionId>VATCode
Code that determines VAT rules used for VAT calculations.
>{String}</VATCode>Description
Description of VAT Code definition
>{String}</Description>VATCodeDefinitionLink
VAT code reference
>{String}</VATCodeDefinitionLink>VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)
>{String}</VATRegistrationNumber>Currency
Three character code following the ISO 4217 standard
>{String}</Currency>Country
Country name of VAT entity
>{String}</Country>CountryCode
Country code of VAT Entity
>{String}</CountryCode>NotificationId
Notification identifier
>{Integer}</NotificationId>Status
Status of the notification
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Message
The message from the notification definition, expanded with parameters.
>{String}</Message>TranslatedMessage
The translated message from the notification definition, expanded with parameters.
>{String}</TranslatedMessage>NotificationTypeId
Notification type identifier
>{String}</NotificationTypeId>Category
Category of notification type (warning, information etc)
Possible domain values can be found here
>{String}</Category>NotificationTypeLink
Notification type reference
>{String}</NotificationTypeLink>NotificationLink
Notification reference
>{String}</NotificationLink>SupplierCreditNoteId
Supplier credit note identifier
": "{Integer}",Status
Status of supplier credit note
Possible domain values can be found here
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",SuppliersReference
Suppliers/sellers reference. Typically a person.
": "{String}",SuppliersInvoiceNumber
Suppliers/sellers reference number. Typically to an external system.
": "{String}",SuppliersPaymentReference
Sellers reference to identify the object. In Norway this is typically a KID-number.
": "{String}",BuyersReferenceNumber
Buyers reference number
": "{String}",IssueDate
Date when the document was issued.
": "{Date}",ReceivedDate
Date when the document was received.
": "{Date}",RegistrationDate
Date of registration
": "{Date}",Currency
Three character code following the ISO 4217 standard
Possible domain values can be found here
": "{String}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
": "{String}",PendingReception
Indicates if the supplier credit note is pending reception
": "{Boolean}",ShipToAttention
Attention of the ship to address. When changing ship to address, the ShipToAttention will be overridden by the attention of the new ship to address.
": "{String}",InvoiceAddressAttention
Attention of the correspondence address. When changing correspondence address, the CorrespondenceAddressAttention will be overridden by the attention of the new correspondence address.
": {IsSubjectedToSplitPayment
Indicates if an customer / supplier invoice and / or credit note is subjected to split payment
": "{Boolean}",PurchaseOutsideEU
Purchase was from outside of EU. Used for the JPK files for "Shortened import procedure outside of EU".
": "{Boolean}"AccountingPeriodId
Accounting period identifier
": "{Integer}",Period
Accounting period
": "{Integer}",AccountingPeriodLink
Accounting period reference
": "{String}"LocationId
Location identifier
": "{Integer}",Name
Name of location
": "{String}",ShortName
Unique abbreviation/short name of the location
": "{String}",LocationLink
Location reference
": "{String}"Assignee
The user who has been assigned to work with this object.
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"SupplierId
RamBase supplier identifier
": "{Integer}",Name
Name of supplier (name of company or surname/familyname/lastname of a person)
": "{String}",Firstname
Firstname/givenname if the supplier is a person
": "{String}",LegalEntityIdentifier
The suppliers unique enterprise/organization number.
": "{String}",VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT).
": "{String}",Code
Intercompany database the supplier belongs to.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}"SupplierLink
Supplier reference
": "{String}"SupplierBankAccountId
Supplier bank account identifier
": "{Integer}",Name
Name of bank account
": "{String}",AccountNumber
Account number used to identify the bank account
": "{String}",SWIFTCode
The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.
": "{String}",InternationalBankAccountNumber
The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.
": "{String}",Address
Address of the bank associated with the bank account
": {CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}"SupplierBankAccountLink
Supplier bank account reference
": "{String}"Currency
Three character code following the ISO 4217 standard
": "{String}",FreightAmount
Freight amount in transaction document's currency
": "{Decimal}",FeeAmount
Fee amount in transaction document's currency
": "{Decimal}",RoundOffAmount
Round-off amount in transaction document's currency
": "{Decimal}",SubTotalAmount
Total amount of the object in object currency, excluding VAT.
": "{Decimal}",VATAmount
Total value added tax in object currency.
": "{Decimal}",TotalAmount
The total amount in object currency, including VAT
": "{Decimal}",VATRoundOffAmount
VAT round-off amount in transaction document's currency
": "{Decimal}",Currency
Currency used in conversion. Default is company accounting currency. Three character code following the ISO 4217 standard.
": "{String}",ExchangeRate
The exchange rate used in convertion
": "{Decimal}",FreightAmount
Freight amount in company currency.
": "{Decimal}",FeeAmount
Fee amount in company currency
": "{Decimal}",RoundOffAmount
Round-off amount in company currency
": "{Decimal}",SubTotalAmount
Total amount of the object in company currency, excluding VAT.
": "{Decimal}",VATAmount
Value added tax amount in company currency.
": "{Decimal}",TotalAmount
The total amount in company currency, including VAT.
": "{Decimal}",VATRoundOffAmount
VAT round-off amount in company currency
": "{Decimal}"Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",Firstname
Firstname if the receiver is a person. Note that default invoice address must have the same firstname as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",Database
Database of the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}",ObjectId
Identifier of the object
": "{Integer}",ObjectType
Type of object
": "{String}",ObjectLink
API reference to the object
": "{String}",RamBaseKey
Internal RamBase identifier of the object/item
": "{String}"AddressId
Address identifier
": "{Integer}",Name
Name of receiver (Name of company or last name of a person). Note that default invoice address must have the same name as the customer.
": "{String}",AddressLine1
First address line
": "{String}",AddressLine2
Second address line
": "{String}",PostalCode
Postalcode/Postcode/ZIP
": "{String}",City
City/town/village
": "{String}",Region
Region/province/state
": "{String}",CountryCode
Two-character code (ISO 3166) identifying the country.
": "{String}",Country
English name of country.
": "{String}",AddressLink
Supplier address reference
": "{String}"PaymentTerms
Terms of payment. Defaut value is retrieved from the supplier.
Possible domain values can be found here
": "{String}",PaymentMethod
Method of payment. Default value is retrieved from the supplier.
Possible domain values can be found here
": "{String}",DueDate
Date the object is due to be paid
": "{Date}"PostponeVAT
Indicates that the VAT posting should be postponed
": "{Boolean}",VATType
Type of value added tax
": "{String}",VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Possible domain values can be found here
": "{String}",VATRate
Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.
": "{Decimal}",VATDate
Date of VAT posting. Currency rate calculation use this date.
": "{Date}",VATPeriod
Accounting period this VAT posting belongs to
": "{Integer}",DefaultVATPercent
Value added tax percent.
": "{Decimal}",VATCodeDefinitionId
VAT code identifier
": "{Integer}",VATCode
Code that determines VAT rules used for VAT calculations.
": "{String}",Description
Description of VAT Code definition
": "{String}",VATCodeDefinitionLink
VAT code reference
": "{String}"VATRegistrationNumber
Unique number assigned by the relevant tax authority to identify a party for use in relation to value added tax (VAT)
": "{String}",Currency
Three character code following the ISO 4217 standard
": "{String}",Country
Country name of VAT entity
": "{String}",CountryCode
Country code of VAT Entity
": "{String}"NotificationId
Notification identifier
": "{Integer}",Status
Status of the notification
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Message
The message from the notification definition, expanded with parameters.
": "{String}",TranslatedMessage
The translated message from the notification definition, expanded with parameters.
": "{String}",NotificationTypeId
Notification type identifier
": "{String}",Category
Category of notification type (warning, information etc)
Possible domain values can be found here
": "{String}",NotificationTypeLink
Notification type reference
": "{String}"NotificationLink
Notification reference
": "{String}"
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 101202 HTTP 404 | Sales credit note item not found |
| Error 103837 HTTP 400 | Recalculation failed. Missing product id. |
| Error 103838 HTTP 400 | Recalculation failed. Missing location. |
| Error 101069 HTTP 404 | Stock assignment link - document not found |
| Error 100345 HTTP 400 | Location is required |
| Error 108514 HTTP 400 | Invalid invoice frequency |
| Error 108635 HTTP 400 | Effective date cannot be later then effective date of any contract item |
| Error 108421 HTTP 400 | The effective date cannot be later than the expiration date |
| Error 108735 HTTP 400 | Expiration date of a contract cannot be earlier then expiration date of any of its quotes |
| Error 108674 HTTP 400 | Termination date cannot be earlier then the effective date |
| Error 108675 HTTP 400 | Termination date cannot be later then the expiration date |
| Error 108672 HTTP 400 | Closing date cannot be earlier then the effective date |
| Error 108673 HTTP 400 | Closing date cannot be later then the expiration date |
| Error 104971 HTTP 400 | The start date cannot be later than the end date |
| Error 108262 HTTP 404 | Recurring rate not found |
| Error 108691 HTTP 400 | Recurring rate is not active |
| Error 108018 HTTP 400 | Currency mismatch |
| Error 108016 HTTP 400 | Product id mismatch |
| Error 108824 HTTP 400 | Cannot apply recurring rate as it is not valid for selected period |
| Error 108671 HTTP 400 | The effective date cannot be changed because earlier days have already been invoiced |
| Error 108684 HTTP 400 | The expiration date cannot be changed because later days have already been invoiced |
| Error 108677 HTTP 400 | Expected delivery date cannot be earlier than the effective date |
| Error 108678 HTTP 400 | Expected collection date cannot be earlier than the effective date |
| Error 108679 HTTP 400 | Expected collection date cannot be earlier then expected delivery date |
| Error 108680 HTTP 400 | Collection date cannot be earlier then the effective date |
| Error 108681 HTTP 400 | Collection date cannot be earlier then the expected delivery date |
| Error 108683 HTTP 400 | Termination date must be earlier then the expiration date |