Procurement APIs
Update provided supplier credit note
| HTTP method | PUT |
| URI | https://api.rambase.net/procurement/credit-notes/{supplierCreditNoteId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {supplierCreditNoteId} |
Supplier credit note identifier
Integer, minimum 100000 |
| Custom fields | Custom fields supported |
| Successful HTTP status code | 200 |
| API resource identifier | 4463, version 7 |
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.
SupplierCreditNote
This field is optional.
>SuppliersReference
Suppliers/sellers reference. Typically a person.
This field is optional.
>{String}</SuppliersReference>SuppliersInvoiceNumber
Suppliers/sellers reference number. Typically to an external system.
This field is optional.
>{String}</SuppliersInvoiceNumber>Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
>{String}</Note>Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
>{String}</Currency>IssueDate
Date when the document was issued.
This field is optional.
>{Date}</IssueDate>ReceivedDate
Date when the document was received.
This field is optional.
>{Date}</ReceivedDate>SuppliersPaymentReference
Sellers reference to identify the object. In Norway this is typically a KID-number.
This field is optional.
>{String}</SuppliersPaymentReference>BuyersReferenceNumber
Buyers reference number
This field is optional.
>{String}</BuyersReferenceNumber>InvoiceAddressAttention
Attention of the correspondence address. When changing correspondence address, the CorrespondenceAddressAttention will be overridden by the attention of the new correspondence address.
This field is optional.
>{String}</InvoiceAddressAttention>AccountingPeriod
This field is optional.
>AccountingPeriodId
Accounting period identifier
Minimum value: 199000
Maximum value: 299912
This field is optional.
>{Integer}</AccountingPeriodId>Supplier
This field is optional.
>SupplierId
RamBase supplier identifier
Minimum value: 100
This field is optional.
>{Integer}</SupplierId>SupplierBankAccount
This field is optional.
>SupplierBankAccountId
Supplier bank account identifier
Minimum value: 1
This field is optional.
>{Integer}</SupplierBankAccountId>Location
This field is optional.
>LocationId
Location identifier
Minimum value: 10000
This field is optional.
>{Integer}</LocationId>ShipFrom
This field is optional.
>AddressId
Address identifier
Minimum value: 1
This field is optional.
>{Integer}</AddressId>Assignee
The user who has been assigned to work with this object.
This field is optional.
>UserId
User identifier
Minimum value: 100
This field is optional.
>{Integer}</UserId>Payment
This field is optional.
>PaymentTerms
Terms of payment. Defaut value is retrieved from the supplier.
Applicable domain values can be found here
This field is optional.
>{String}</PaymentTerms>DueDate
Date the object is due to be paid
This field is optional.
>{Date}</DueDate>Totals
This field is optional.
>FreightAmount
Freight amount in transaction document's currency
Minimum value: 0
This field is optional.
>{Decimal}</FreightAmount>FeeAmount
Fee amount in transaction document's currency
Minimum value: 0
This field is optional.
>{Decimal}</FeeAmount>RoundOffAmount
Round-off amount in transaction document's currency
This field is optional.
>{Decimal}</RoundOffAmount>VATRoundOffAmount
VAT round-off amount in transaction document's currency
This field is optional.
>{Decimal}</VATRoundOffAmount>VATDetails
This field is optional.
>PostponeVAT
Indicates that the VAT posting should be postponed
This field is optional.
>{Boolean}</PostponeVAT>VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Applicable domain values can be found here
This field is optional.
>{String}</VATHandling>VATRate
Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.
This field is optional.
>{Decimal}</VATRate>VATDate
Date of VAT posting. Currency rate calculation use this date.
This field is optional.
>{Date}</VATDate>VATPeriod
Accounting period this VAT posting belongs to
Minimum value: 199000
Maximum value: 299912
This field is optional.
>{Integer}</VATPeriod>PolishRequirements
This field is optional.
>PurchaseOutsideEU
Purchase was from outside of EU. Used for the JPK files for "Shortened import procedure outside of EU".
This field is optional.
>{Boolean}</PurchaseOutsideEU>SupplierCreditNote
This field is optional.
": {SuppliersReference
Suppliers/sellers reference. Typically a person.
This field is optional.
": "{String}",SuppliersInvoiceNumber
Suppliers/sellers reference number. Typically to an external system.
This field is optional.
": "{String}",Note
Additional information regarding the object (free text). This note might be visible to customers/suppliers.
This field is optional.
": "{String}",Currency
Three character code following the ISO 4217 standard
Applicable domain values can be found here
This field is optional.
": "{String}",IssueDate
Date when the document was issued.
This field is optional.
": "{Date}",ReceivedDate
Date when the document was received.
This field is optional.
": "{Date}",SuppliersPaymentReference
Sellers reference to identify the object. In Norway this is typically a KID-number.
This field is optional.
": "{String}",BuyersReferenceNumber
Buyers reference number
This field is optional.
": "{String}",InvoiceAddressAttention
Attention of the correspondence address. When changing correspondence address, the CorrespondenceAddressAttention will be overridden by the attention of the new correspondence address.
This field is optional.
": "{String}",AccountingPeriod
This field is optional.
": {AccountingPeriodId
Accounting period identifier
Minimum value: 199000
Maximum value: 299912
This field is optional.
": "{Integer}"Supplier
This field is optional.
": {SupplierId
RamBase supplier identifier
Minimum value: 100
This field is optional.
": "{Integer}"SupplierBankAccount
This field is optional.
": {SupplierBankAccountId
Supplier bank account identifier
Minimum value: 1
This field is optional.
": "{Integer}"Location
This field is optional.
": {LocationId
Location identifier
Minimum value: 10000
This field is optional.
": "{Integer}"ShipFrom
This field is optional.
": {AddressId
Address identifier
Minimum value: 1
This field is optional.
": "{Integer}"Assignee
The user who has been assigned to work with this object.
This field is optional.
": {UserId
User identifier
Minimum value: 100
This field is optional.
": "{Integer}"Payment
This field is optional.
": {PaymentTerms
Terms of payment. Defaut value is retrieved from the supplier.
Applicable domain values can be found here
This field is optional.
": "{String}",DueDate
Date the object is due to be paid
This field is optional.
": "{Date}"Totals
This field is optional.
": {FreightAmount
Freight amount in transaction document's currency
Minimum value: 0
This field is optional.
": "{Decimal}",FeeAmount
Fee amount in transaction document's currency
Minimum value: 0
This field is optional.
": "{Decimal}",RoundOffAmount
Round-off amount in transaction document's currency
This field is optional.
": "{Decimal}",VATRoundOffAmount
VAT round-off amount in transaction document's currency
This field is optional.
": "{Decimal}"VATDetails
This field is optional.
": {PostponeVAT
Indicates that the VAT posting should be postponed
This field is optional.
": "{Boolean}",VATHandling
Specifies how value added tax (VAT) should be calculated. Either always include VAT, always exclude VAT or use standard/default VAT rules.
Applicable domain values can be found here
This field is optional.
": "{String}",VATRate
Rate between transaction currency and company VAT currency. VAT rate should be used to calculate VAT amount in company VAT currency.
This field is optional.
": "{Decimal}",VATDate
Date of VAT posting. Currency rate calculation use this date.
This field is optional.
": "{Date}",VATPeriod
Accounting period this VAT posting belongs to
Minimum value: 199000
Maximum value: 299912
This field is optional.
": "{Integer}"PolishRequirements
This field is optional.
": {PurchaseOutsideEU
Purchase was from outside of EU. Used for the JPK files for "Shortened import procedure outside of EU".
This field is optional.
": "{Boolean}"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. |
| $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. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
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 101419 HTTP 400 | The location of the item has different country code than the location on the document |
| 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 |