Bill Credit Memos

The BillCreditMemo Object

A Rutter Bill Credit Memo represents a bill credit memo issued from a vendor that can be applied against a bill. Every bill credit memo is linked to an Vendor and zero or more Bills.

Properties

idstring

The Rutter generated unique ID of the bill credit memo.

platform_idstring

The platform specific ID of the bill credit memo.

account_idstringnullable

The Rutter ID of the Account linked to the bill credit memo. Represents the account being credited. This is typically the primary Accounts Payable account.

vendor_idstringnullable

The Rutter ID of the Vendor linked to the bill credit memo.

allocated_atstringnullable

The ISO 8601 timestamp for when the bill credit memo was allocated.

issue_datestring

The ISO 8601 timestamp for when the bill credit memo was issued.

document_numberstring

The buyer facing document number of the bill credit memo.

statusenum

The status of the bill credit memo.

One ofopenpartially_paidpaidvoiddraftunknown, or submitted.
currency_codeenumnullable

The ISO 4217 currency code of the bill credit memo.

One ofAEDAFNALLAMDANGAOAARSAUDAWGAZNBAMBBDBDTBGNBHDBIFBMDBNDBOBBOVBRLBSDBTNBWPBYRBZDCADCDFCHECHFCHWCLFCLPCNYCOPCOUCRCCUCCUPCVECZKDJFDKKDOPDZDEGPERNETBEURFJDFKPGBPGELGHSGIPGMDGNFGTQGYDHKDHNLHRKHTGHUFIDRILSINRIQDIRRISKJMDJODJPYKESKGSKHRKMFKPWKRWKWDKYDKZTLAKLBPLKRLRDLSLLTLLVLLYDMADMDLMGAMKDMMKMNTMOPMROMURMVRMWKMXNMXVMYRMZNNADNGNNIONOKNPRNZDOMRPABPENPGKPHPPKRPLNPYGQARRONRSDRUBRWFSARSBDSCRSDGSEKSGDSHPSLLSOSSRDSSPSTDSVCSYPSZLTHBTJSTMTTNDTOPTRYTTDTWDTZSUAHUGXUSDUSNUSSUYIUYUUYWUZSVEFVNDVUVWSTXAFXAGXAUXBAXBBXBCXBDXCDXDRXFUXOFXPDXPFXPTXTSXXXYERZAR, or ZMW.
memostringnullable

The memo of the bill credit memo

remaining_amountstringnullable

The remaining unapplied amount of the bill credit memo.

total_amountstringnullable

The total amount of the bill credit memo.

linked_billsarray

An array of Rutter IDs of Bills applied against the BillCreditMemo.

Show linked_bills attributes
line_itemsarray

An array of line items associated with the BillCreditMemo.

Show line_items attributes
created_atstringfilterablenullable

The ISO 8601 timestamp that the bill credit memo was created.

updated_atstringfilterablenullable

The ISO 8601 timestamp that the bill credit memo was last updated.

last_synced_atstringfilterable

The ISO 8601 timestamp when the bill credit memo was last synced by Rutter.

platform_urlstringnullable

A URL pointing to the object in the underlying platform. When no URL exists for the specific object, the value may be a larger URL containing the object.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/accounting/bill_credit_memos
GET
/accounting/bill_credit_memos/:id
POST
/accounting/bill_credit_memos
POST
/accounting/bill_credit_applications

List Bill Credit Memos

GEThttps://production.rutterapi.com/versioned/accounting/bill_credit_memos

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    filterstringqueryOptional

    Used to specify criteria to filter out the objects returned. Supports all filterable fields. Check Filtering Objects for more information. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

    sortstringqueryOptional

    Used to sort the returned objects, e.g. last_synced_at ASC. Supports all filterable fields except on QuickBooks Desktop, Sage Intacct, and Dynamics 365. For those platforms only updated_at and last_synced_at fields are supported. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    last_synced_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_maxintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_minintegerqueryOptional

    Deprecated - use filter instead. Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

    bill_credit_memosarray
    Show bill_credit_memos attributes
    next_cursorstringnullableOptional
    connectionobject
    Show connection attributes
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
Example Response Body
JSON
1
{
2
"bill_credit_memos": [
3
{
4
"id": "00000000-0000-0000-0000-000000000000",
5
"platform_id": "12345678",
6
"account_id": "00000000-0000-0000-0000-000000000000",
7
"vendor_id": "00000000-0000-0000-0000-000000000000",
8
"allocated_at": "2023-01-02T02:34:56.000Z",
9
"issue_date": "2023-01-02T02:34:56.000Z",
10
"document_number": "VENDCRED-1",
11
"status": "paid",
12
"currency_code": "USD",
13
"memo": "Discount for future Rutter shirts.",
14
"remaining_amount": "0",
15
"total_amount": "3",
16
"linked_bills": [
17
{
18
"id": "00000000-0000-0000-0000-000000000000",
19
"allocated_date": "2023-01-02T02:34:56.000Z",
20
"allocated_amount": "3"
21
}
22
],
23
"line_items": [
24
{
25
"id": "00000000-0000-0000-0000-000000000000",
26
"account_id": "00000000-0000-0000-0000-000000000000",
27
"class_id": "00000000-0000-0000-0000-000000000000",
28
"customer_id": "00000000-0000-0000-0000-000000000000",
29
"department_id": "00000000-0000-0000-0000-000000000000",
30
"item_id": "00000000-0000-0000-0000-000000000000",
31
"location_id": "00000000-0000-0000-0000-000000000000",
32
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
33
"description": "A Rutter shirt.",
34
"amount": "14.34",
35
"discount_amount": "0",
36
"discount_percentage": "0",
37
"quantity": "1",
38
"sub_total": "12.34",
39
"tax_amount": "2",
40
"unit_amount": "12.34",
41
"item": {
42
"id": "00000000-0000-0000-0000-000000000000",
43
"quantity": 1,
44
"unit_amount": 12.34
45
}
46
}
47
],
48
"created_at": "2023-01-02T02:34:56.000Z",
49
"updated_at": "2023-01-02T02:34:56.000Z",
50
"last_synced_at": "2023-01-02T02:34:56.000Z",
51
"platform_url": "https://platform.com/resource?id=123",
52
"platform_data": {
53
"id": 123,
54
"data": "Varies by platform"
55
}
56
}
57
],
58
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
59
"connection": {
60
"id": "00000000-0000-0000-0000-000000000000",
61
"orgId": "00000000-0000-0000-0000-000000000000",
62
"platform": "NETSUITE"
63
}
64
}

Fetch a Bill Credit Memo

GEThttps://production.rutterapi.com/versioned/accounting/bill_credit_memos/:id

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not supported on QuickBooks Desktop, Sage Intacct, or Dynamics 365.

    One ofrutter or platform.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

    bill_credit_memoobject
    Show bill_credit_memo attributes
    connectionobject
    Show connection attributes
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
Example Response Body
JSON
1
{
2
"bill_credit_memo": {
3
"id": "00000000-0000-0000-0000-000000000000",
4
"platform_id": "12345678",
5
"account_id": "00000000-0000-0000-0000-000000000000",
6
"vendor_id": "00000000-0000-0000-0000-000000000000",
7
"allocated_at": "2023-01-02T02:34:56.000Z",
8
"issue_date": "2023-01-02T02:34:56.000Z",
9
"document_number": "VENDCRED-1",
10
"status": "paid",
11
"currency_code": "USD",
12
"memo": "Discount for future Rutter shirts.",
13
"remaining_amount": "0",
14
"total_amount": "3",
15
"linked_bills": [
16
{
17
"id": "00000000-0000-0000-0000-000000000000",
18
"allocated_date": "2023-01-02T02:34:56.000Z",
19
"allocated_amount": "3"
20
}
21
],
22
"line_items": [
23
{
24
"id": "00000000-0000-0000-0000-000000000000",
25
"account_id": "00000000-0000-0000-0000-000000000000",
26
"class_id": "00000000-0000-0000-0000-000000000000",
27
"customer_id": "00000000-0000-0000-0000-000000000000",
28
"department_id": "00000000-0000-0000-0000-000000000000",
29
"item_id": "00000000-0000-0000-0000-000000000000",
30
"location_id": "00000000-0000-0000-0000-000000000000",
31
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
32
"description": "A Rutter shirt.",
33
"amount": "14.34",
34
"discount_amount": "0",
35
"discount_percentage": "0",
36
"quantity": "1",
37
"sub_total": "12.34",
38
"tax_amount": "2",
39
"unit_amount": "12.34",
40
"item": {
41
"id": "00000000-0000-0000-0000-000000000000",
42
"quantity": 1,
43
"unit_amount": 12.34
44
}
45
}
46
],
47
"created_at": "2023-01-02T02:34:56.000Z",
48
"updated_at": "2023-01-02T02:34:56.000Z",
49
"last_synced_at": "2023-01-02T02:34:56.000Z",
50
"platform_url": "https://platform.com/resource?id=123",
51
"platform_data": {
52
"id": 123,
53
"data": "Varies by platform"
54
}
55
},
56
"connection": {
57
"id": "00000000-0000-0000-0000-000000000000",
58
"orgId": "00000000-0000-0000-0000-000000000000",
59
"platform": "NETSUITE"
60
}
61
}

Create a Bill Credit Memo

POSThttps://production.rutterapi.com/versioned/accounting/bill_credit_memos

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    bill_credit_memoobject
    Show bill_credit_memo attributes

Response Body

    Any of:

    bill_credit_memoobject
    Show bill_credit_memo attributes
    async_responseobjectOptional
    Show async_response attributes
    errorsarrayOptional
    Show errors attributes
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
Example Request Body
JSON
1
{
2
"bill_credit_memo": {
3
"account_id": "00000000-0000-0000-0000-000000000000",
4
"vendor_id": "00000000-0000-0000-0000-000000000000",
5
"issue_date": "2023-01-02T02:34:56.000Z",
6
"currency_code": "USD",
7
"line_items": [
8
{
9
"account_id": "00000000-0000-0000-0000-000000000000",
10
"amount": 12.34,
11
"description": "A Rutter shirt."
12
}
13
]
14
}
15
}
Example Response Body
JSON
1
{
2
"bill_credit_memo": {
3
"id": "00000000-0000-0000-0000-000000000000",
4
"platform_id": "12345678",
5
"account_id": "00000000-0000-0000-0000-000000000000",
6
"vendor_id": "00000000-0000-0000-0000-000000000000",
7
"allocated_at": "2023-01-02T02:34:56.000Z",
8
"issue_date": "2023-01-02T02:34:56.000Z",
9
"document_number": "VENDCRED-1",
10
"status": "paid",
11
"currency_code": "USD",
12
"memo": "Discount for future Rutter shirts.",
13
"remaining_amount": "0",
14
"total_amount": "3",
15
"linked_bills": [
16
{
17
"id": "00000000-0000-0000-0000-000000000000",
18
"allocated_date": "2023-01-02T02:34:56.000Z",
19
"allocated_amount": "3"
20
}
21
],
22
"line_items": [
23
{
24
"id": "00000000-0000-0000-0000-000000000000",
25
"account_id": "00000000-0000-0000-0000-000000000000",
26
"class_id": "00000000-0000-0000-0000-000000000000",
27
"customer_id": "00000000-0000-0000-0000-000000000000",
28
"department_id": "00000000-0000-0000-0000-000000000000",
29
"item_id": "00000000-0000-0000-0000-000000000000",
30
"location_id": "00000000-0000-0000-0000-000000000000",
31
"tax_rate_id": "00000000-0000-0000-0000-000000000000",
32
"description": "A Rutter shirt.",
33
"amount": "14.34",
34
"discount_amount": "0",
35
"discount_percentage": "0",
36
"quantity": "1",
37
"sub_total": "12.34",
38
"tax_amount": "2",
39
"unit_amount": "12.34",
40
"item": {
41
"id": "00000000-0000-0000-0000-000000000000",
42
"quantity": 1,
43
"unit_amount": 12.34
44
}
45
}
46
],
47
"created_at": "2023-01-02T02:34:56.000Z",
48
"updated_at": "2023-01-02T02:34:56.000Z",
49
"last_synced_at": "2023-01-02T02:34:56.000Z",
50
"platform_url": "https://platform.com/resource?id=123",
51
"platform_data": {
52
"id": 123,
53
"data": "Varies by platform"
54
}
55
}
56
}

Create a Bill Credit Application

POSThttps://production.rutterapi.com/versioned/accounting/bill_credit_applications

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

Request Body

    bill_credit_applicationobject
    Show bill_credit_application attributes

Response Body

    Any of:

    bill_credit_applicationobject
    Show bill_credit_application attributes
    async_responseobjectOptional
    Show async_response attributes
    errorsarrayOptional
    Show errors attributes
Support by integration
  • QuickBooks
    QuickBooks
  • NetSuite
    NetSuite
  • Xero
    Xero
  • QuickBooks Desktop
    QuickBooks Desktop
Example Request Body
JSON
1
{
2
"bill_credit_application": {
3
"bill_credit_memo_id": "00000000-0000-0000-0000-000000000000",
4
"vendor_id": "00000000-0000-0000-0000-000000000000",
5
"transaction_date": "2023-01-02T02:34:56.000Z",
6
"currency_code": "USD",
7
"memo": "Applying vendor credit for bill.",
8
"linked_bills": [
9
{
10
"id": "00000000-0000-0000-0000-000000000000",
11
"allocated_amount": 12.34
12
}
13
]
14
}
15
}
Example Response Body
JSON
1
{
2
"bill_credit_application": {
3
"success": true
4
}
5
}

Have questions?

Contact support for personalized guidance.

Contact support